org.apache.tinkerpop.gremlin.structure.util.keyed

Class KeyedVertexProperty<V>

java.lang.Object

org.apache.tinkerpop.gremlin.structure.util.keyed.KeyedVertexProperty<V>

All Implemented Interfaces:

Element, Property<V>, VertexProperty<V>

public final class KeyedVertexProperty<V>
extends Object
implements VertexProperty<V>

A utility implementation of a Property that only has a key but no value and no meta-properties.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.VertexProperty

VertexProperty.Cardinality, VertexProperty.Exceptions

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.VertexProperty

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
KeyedVertexProperty(String key)

Method Summary

Modifier and Type	Method and Description
Vertex	element() Gets the Vertex that owns this VertexProperty.
boolean	equals(Object o)
Graph	graph() Get the graph that this element is within.
int	hashCode()
Object	id() Gets the unique identifier for the graph Element.
boolean	isPresent() Whether the property is empty or not.
String	key() The key of the property.
<U> Iterator<Property<U>>	properties(String... propertyKeys) Get an Iterator of properties where the propertyKeys is meant to be a filter on the available keys.
<U> Property<U>	property(String key) Get a Property for the Element given its key.
<U> Property<U>	property(String key, U value) Add or set a property value for the Element given its key.
void	remove() Remove the property from the associated element.
String	toString()
V	value() The value of the property.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.VertexProperty

empty, label

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Property

ifPresent, orElse, orElseGet, orElseThrow

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Element

keys, value, values

Constructor Detail

KeyedVertexProperty

public KeyedVertexProperty(String key)

Method Detail

element

public Vertex element()

Description copied from interface: VertexProperty

Gets the Vertex that owns this VertexProperty.

Specified by:

element in interface Property<V>

Specified by:

element in interface VertexProperty<V>

Returns:

The element associated with this property (i.e. Vertex, Edge, or VertexProperty).

id

public Object id()

Description copied from interface: Element

Gets the unique identifier for the graph Element.

Specified by:

id in interface Element

Returns:

The id of the element

graph

public Graph graph()

Description copied from interface: VertexProperty

Get the graph that this element is within.

Specified by:

graph in interface Element

Specified by:

graph in interface VertexProperty<V>

Returns:

the graph of this element

property

public <U> Property<U> property(String key)

Description copied from interface: Element

Get a Property for the Element given its key. The default implementation calls the raw Element.properties(java.lang.String...).

Specified by:

property in interface Element

property

public <U> Property<U> property(String key,
                                U value)

Description copied from interface: Element

Add or set a property value for the Element given its key.

Specified by:

property in interface Element

key

public String key()

Description copied from interface: Property

The key of the property.

Specified by:

key in interface Property<V>

Returns:

The property key

value

public V value()
        throws NoSuchElementException

Description copied from interface: Property

The value of the property.

Specified by:

value in interface Property<V>

Returns:

The property value

Throws:

NoSuchElementException - thrown if the property is empty

isPresent

public boolean isPresent()

Description copied from interface: Property

Whether the property is empty or not.

Specified by:

isPresent in interface Property<V>

Returns:

True if the property exists, else false

remove

public void remove()

Description copied from interface: Property

Remove the property from the associated element.

Specified by:

remove in interface Element

Specified by:

remove in interface Property<V>

toString

public String toString()

Overrides:

toString in class Object

properties

public <U> Iterator<Property<U>> properties(String... propertyKeys)

Description copied from interface: VertexProperty

Get an Iterator of properties where the propertyKeys is meant to be a filter on the available keys. If no keys are provide then return all the properties.

Specified by:

properties in interface Element

Specified by:

properties in interface VertexProperty<V>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object