oracle.pgx.api

Class PgxCollection<E,ID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.Destroyable

oracle.pgx.api.PgxManagedObject

oracle.pgx.api.PgxCollection<E,ID>

Type Parameters:

E - the element type

ID - the ID type of the element type

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<E>, oracle.pgx.common.IdentifiableCollection

Direct Known Subclasses:

GraphEntityCollection, ScalarCollection

public abstract class PgxCollection<E,ID>
extends PgxManagedObject
implements java.lang.Iterable<E>, oracle.pgx.common.IdentifiableCollection

Superclass for Pgx collections.

Method Summary

Modifier and Type	Method and Description
void	add(E entity) Adds one element to this collection.
abstract void	addAll(PgxEntity[] elements) Adds elements of a PgxEntity array to this collection.
PgxFuture<java.lang.Void>	addAllAsync(E[] elements) Add elements to an existing collection.
void	addAllElements(java.util.Collection<E> source) Blocking version of addAllElementsAsync(Collection).
abstract PgxFuture<java.lang.Void>	addAllElementsAsync(java.util.Collection<E> source) Adds elements to an existing collection.
void	clear() Blocking version of clearAsync().
PgxFuture<java.lang.Void>	clearAsync() Clear an existing collection
PgxCollection<E,ID>	clone()
PgxCollection<E,ID>	clone(java.lang.String newName) Blocking version of clone(String).
PgxFuture<PgxCollection<E,ID>>	cloneAsync() Convenience method around cloneAsync(String) passing name as null Clone an existing collection.
PgxFuture<PgxCollection<E,ID>>	cloneAsync(java.lang.String newName) Clone an existing collection.
boolean	contains(E element) Blocking version of #containsAsync(E).
abstract PgxFuture<java.lang.Boolean>	containsAsync(E element) Returns true if this collection contains the specified element.
PgxFuture<java.lang.Void>	destroyAsync() Requests destruction of this object.
CollectionType	getCollectionType() Gets the collection type.
PropertyType	getContentType() Gets this collection's content type.
PgxGraph	getGraph() Gets the graph.
oracle.pgx.common.PgxId	getId() Returns an internal identifier for this collection.
abstract IdType	getIdType() Gets the ID type of the element type.
java.lang.String	getName()
boolean	isMutable() Blocking version of isMutableAsync().
PgxFuture<java.lang.Boolean>	isMutableAsync() Checks whether an existing collection is mutable
java.util.Iterator<E>	iterator() Blocking version of iteratorAsync().
PgxFuture<java.util.Iterator<E>>	iteratorAsync() Gets an Iterator over the collection.
void	remove(E entity) Removes one element from this collection.
void	removeAllElements(java.util.Collection<E> source) Blocking version of removeAllElementsAsync(Collection).
abstract PgxFuture<java.lang.Void>	removeAllElementsAsync(java.util.Collection<E> source) Removes elements from an existing collection.
int	size() Blocking version of sizeAsync().
PgxFuture<java.lang.Integer>	sizeAsync() Gets the number of elements in this collection
java.util.stream.Stream<E>	stream() Creates a new sequential or parallel Stream from Spliterator.
PgxCollection<E,ID>	toMutable() Blocking version of toMutableAsync().
PgxCollection<E,ID>	toMutable(java.lang.String newName) Blocking version of toMutableAsync(String).
PgxFuture<PgxCollection<E,ID>>	toMutableAsync() Create a mutable copy of an existing collection
PgxFuture<PgxCollection<E,ID>>	toMutableAsync(java.lang.String newName) Create a mutable copy of an existing collection
java.lang.String	toString() (non-Javadoc)

Methods inherited from class oracle.pgx.api.PgxManagedObject

equals, hashCode

Methods inherited from class oracle.pgx.api.Destroyable

close, destroy

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

public void add(E entity)

Adds one element to this collection.

Parameters:

entity - the entity

addAll

public abstract void addAll(PgxEntity[] elements)

Adds elements of a PgxEntity array to this collection.

Parameters:

elements - the PgxEntity array containing the elements to add

addAllAsync

public PgxFuture<java.lang.Void> addAllAsync(E[] elements)

Add elements to an existing collection.

Parameters:

elements - elements to add

addAllElements

public void addAllElements(java.util.Collection<E> source)

Blocking version of addAllElementsAsync(Collection). Calls addAllElementsAsync(Collection) and waits for the returned PgxFuture to complete.

addAllElementsAsync

public abstract PgxFuture<java.lang.Void> addAllElementsAsync(java.util.Collection<E> source)

Adds elements to an existing collection.

Parameters:

source - elements to add

clear

public void clear()

Blocking version of clearAsync(). Calls clearAsync() and waits for the returned PgxFuture to complete.

clearAsync

public PgxFuture<java.lang.Void> clearAsync()

Clear an existing collection

clone

public PgxCollection<E,ID> clone()

Overrides:

clone in class java.lang.Object

clone

public PgxCollection<E,ID> clone(java.lang.String newName)
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.ExecutionException

Blocking version of clone(String). Calls clone(String) and waits for the returned PgxFuture to complete.

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

cloneAsync

public PgxFuture<PgxCollection<E,ID>> cloneAsync()

Convenience method around cloneAsync(String) passing name as null
Clone an existing collection.

Returns:

the cloned collection

cloneAsync

public PgxFuture<PgxCollection<E,ID>> cloneAsync(java.lang.String newName)

Clone an existing collection.

Parameters:

newName - name of the new collection

Returns:

the cloned collection

contains

public boolean contains(E element)

Blocking version of #containsAsync(E). Calls #containsAsync(E) and waits for the returned PgxFuture to complete.

containsAsync

public abstract PgxFuture<java.lang.Boolean> containsAsync(E element)

Returns true if this collection contains the specified element.

Parameters:

element - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

destroyAsync

public PgxFuture<java.lang.Void> destroyAsync()

Description copied from class: Destroyable

Requests destruction of this object. After this method returns, the behavior of any method of this class becomes undefined.

Specified by:

destroyAsync in class Destroyable

Returns:

a future which will be completed once the destruction request finishes.

getCollectionType

public CollectionType getCollectionType()

Gets the collection type.

Returns:

the collection type

getContentType

public PropertyType getContentType()

Gets this collection's content type.

Returns:

this collection's content type

Since:

2.7.0

getGraph

public PgxGraph getGraph()

Gets the graph.

Returns:

the graph this PgxCollection is bound to

getId

public oracle.pgx.common.PgxId getId()

Returns an internal identifier for this collection. Only meant for internal usage.

Specified by:

getId in interface oracle.pgx.common.IdentifiableCollection

Returns:

the internal identifier of this collection

Since:

20.0

getIdType

public abstract IdType getIdType()

Gets the ID type of the element type.

Returns:

the ID type of the element type.

getName

public java.lang.String getName()

Specified by:

getName in class PgxManagedObject

Returns:

the name identifying this managed object

isMutable

public boolean isMutable()
                  throws java.util.concurrent.ExecutionException,
                         java.lang.InterruptedException

Blocking version of isMutableAsync(). Calls isMutableAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

isMutableAsync

public PgxFuture<java.lang.Boolean> isMutableAsync()

Checks whether an existing collection is mutable

Returns:

true if the collection is mutable, false if it is immutable

iterator

public java.util.Iterator<E> iterator()

Blocking version of iteratorAsync(). Calls iteratorAsync() and waits for the returned PgxFuture to complete.

Specified by:

iterator in interface java.lang.Iterable<E>

iteratorAsync

public PgxFuture<java.util.Iterator<E>> iteratorAsync()

Gets an Iterator over the collection.

Returns:

an Iterator over the collection

remove

public void remove(E entity)

Removes one element from this collection.

Parameters:

entity - the entity

removeAllElements

public void removeAllElements(java.util.Collection<E> source)

Blocking version of removeAllElementsAsync(Collection). Calls removeAllElementsAsync(Collection) and waits for the returned PgxFuture to complete.

removeAllElementsAsync

public abstract PgxFuture<java.lang.Void> removeAllElementsAsync(java.util.Collection<E> source)

Removes elements from an existing collection.

Parameters:

source - elements to remove

size

public int size()

Blocking version of sizeAsync(). Calls sizeAsync() and waits for the returned PgxFuture to complete.

sizeAsync

public PgxFuture<java.lang.Integer> sizeAsync()

Gets the number of elements in this collection

Returns:

number of elements in this collection

stream

public java.util.stream.Stream<E> stream()

Creates a new sequential or parallel Stream from Spliterator.

Returns:

a new sequential or parallel Stream

toMutable

public PgxCollection<E,ID> toMutable()
                              throws java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException

Blocking version of toMutableAsync(). Calls toMutableAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

toMutable

public PgxCollection<E,ID> toMutable(java.lang.String newName)
                              throws java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException

Blocking version of toMutableAsync(String). Calls toMutableAsync(String) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

toMutableAsync

public PgxFuture<PgxCollection<E,ID>> toMutableAsync()

Create a mutable copy of an existing collection

Convenience method around toMutableAsync(String) passing name as null

Returns:

the mutable copy

toMutableAsync

public PgxFuture<PgxCollection<E,ID>> toMutableAsync(java.lang.String newName)

Create a mutable copy of an existing collection

Parameters:

newName - name of the new collection

Returns:

the mutable copy

toString

public java.lang.String toString()

(non-Javadoc)

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()