Package org.apache.tinkerpop.gremlin.structure.util.reference

Class ReferenceProperty<V>

java.lang.Object

org.apache.tinkerpop.gremlin.structure.util.reference.ReferenceProperty<V>

All Implemented Interfaces:

Serializable, Property<V>, Attachable<Property<V>>

public class ReferenceProperty<V>
extends Object
implements Attachable<Property<V>>, Serializable, Property<V>

Author:

Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary

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

Attachable.Exceptions, Attachable.Method

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

Property.Exceptions

Constructor Summary

Constructors

Constructor	Description
ReferenceProperty(String key, V value)
ReferenceProperty(Property<V> property)

Method Summary

Modifier and Type	Method	Description
Element	element()	Get the element that this property is associated with.
boolean	equals(Object object)
Property<V>	get()	Get the raw object trying to be attached.
int	hashCode()
boolean	isPresent()	Whether the property is empty or not.
String	key()	The key of the property.
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.util.Attachable

attach

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

ifPresent, orElse, orElseGet, orElseThrow

Constructor Detail

ReferenceProperty

public ReferenceProperty(Property<V> property)

ReferenceProperty

public ReferenceProperty(String key,
                         V value)

Method Detail

get

public Property<V> get()

Description copied from interface: Attachable

Get the raw object trying to be attached.

Specified by:

get in interface Attachable<V>

Returns:

the raw object to attach

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

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

element

public Element element()

Description copied from interface: Property

Get the element that this property is associated with.

Specified by:

element in interface Property<V>

Returns:

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

remove

public void remove()

Description copied from interface: Property

Remove the property from the associated element.

Specified by:

remove in interface Property<V>