Package oracle.pgx.api

Class ComponentCollection<ID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.Destroyable

oracle.pgx.api.PgxManagedObject

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

oracle.pgx.api.GraphEntityCollection<PgxVertex<ID>,ID>

oracle.pgx.api.VertexCollection<ID>

oracle.pgx.api.ComponentCollection<ID>

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<PgxVertex<ID>>, oracle.pgx.common.IdentifiableCollection, oracle.pgx.common.IdentifiableVertexCollection

public class ComponentCollection<ID>
extends VertexCollection<ID>

Constructor Summary

Constructors

Constructor	Description
ComponentCollection(PgxGraph graph, oracle.pgx.common.PgxId collectionNamespace, long id)

Method Summary

Modifier and Type	Method	Description
PgxFuture<java.lang.Void>	addAllElementsAsync(java.util.Collection<PgxVertex<ID>> source)	Adds elements to an existing collection.
PgxFuture<java.lang.Void>	clearAsync()	Clear an existing collection
PgxFuture<PgxCollection<PgxVertex<ID>,ID>>	cloneAsync(java.lang.String newName)	Clone an existing collection.
PgxFuture<java.lang.Boolean>	containsAsync(PgxVertex<ID> element)	Returns true if this collection contains the specified element.
PgxFuture<java.lang.Void>	destroyAsync()	Requests destruction of this object.
boolean	isMutable()	Blocking version of PgxCollection.isMutableAsync().
PgxFuture<java.lang.Boolean>	isMutableAsync()	Checks whether an existing collection is mutable
PgxFuture<java.lang.Void>	removeAllElementsAsync(java.util.Collection<PgxVertex<ID>> source)	Removes elements from an existing collection.
PgxFuture<PgxCollection<PgxVertex<ID>,ID>>	toMutableAsync(java.lang.String newName)	Create a mutable copy of an existing collection

Methods inherited from class oracle.pgx.api.VertexCollection

addAllById, getIdType, removeAllById

Methods inherited from class oracle.pgx.api.GraphEntityCollection

addAll, addAllById, addAllByIdAsync, removeAllById, removeAllByIdAsync

Methods inherited from class oracle.pgx.api.PgxCollection

add, addAllAsync, addAllElements, clear, clone, clone, cloneAsync, contains, getCollectionType, getContentType, getGraph, getId, getName, iterator, iteratorAsync, remove, removeAllElements, size, sizeAsync, stream, toMutable, toMutable, toMutableAsync, toString

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 oracle.pgx.common.IdentifiableCollection

getId

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ComponentCollection

public ComponentCollection(PgxGraph graph,
                           oracle.pgx.common.PgxId collectionNamespace,
                           long id)

Method Detail

cloneAsync

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

Description copied from class: PgxCollection

Clone an existing collection.

Overrides:

cloneAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

newName - name of the new collection

Returns:

the cloned collection

addAllElementsAsync

public PgxFuture<java.lang.Void> addAllElementsAsync(java.util.Collection<PgxVertex<ID>> source)

Description copied from class: PgxCollection

Adds elements to an existing collection.

Overrides:

addAllElementsAsync in class GraphEntityCollection<PgxVertex<ID>,ID>

Parameters:

source - elements to add

removeAllElementsAsync

public PgxFuture<java.lang.Void> removeAllElementsAsync(java.util.Collection<PgxVertex<ID>> source)

Description copied from class: PgxCollection

Removes elements from an existing collection.

Overrides:

removeAllElementsAsync in class GraphEntityCollection<PgxVertex<ID>,ID>

Parameters:

source - elements to remove

clearAsync

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

Description copied from class: PgxCollection

Clear an existing collection

Overrides:

clearAsync in class PgxCollection<PgxVertex<ID>,ID>

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.

Overrides:

destroyAsync in class PgxCollection<PgxVertex<ID>,ID>

Returns:

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

toMutableAsync

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

Description copied from class: PgxCollection

Create a mutable copy of an existing collection

Overrides:

toMutableAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

newName - name of the new collection

Returns:

the mutable copy

isMutableAsync

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

Description copied from class: PgxCollection

Checks whether an existing collection is mutable

Overrides:

isMutableAsync in class PgxCollection<PgxVertex<ID>,ID>

Returns:

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

isMutable

public boolean isMutable()

Description copied from class: PgxCollection

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

Overrides:

isMutable in class PgxCollection<PgxVertex<ID>,ID>

containsAsync

public PgxFuture<java.lang.Boolean> containsAsync(PgxVertex<ID> element)

Description copied from class: PgxCollection

Returns true if this collection contains the specified element.

Overrides:

containsAsync in class GraphEntityCollection<PgxVertex<ID>,ID>

Parameters:

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

Returns:

true if this collection contains the specified element