oracle.pgx.common.types

Enum EntityType

java.lang.Object

java.lang.Enum<EntityType>

oracle.pgx.common.types.EntityType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EntityType>, Type

public enum EntityType
extends java.lang.Enum<EntityType>
implements Type

enum to distinguish graph entities Node and Edge

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDGE Entity is a edge.
ROW Entity is a row.
VERTEX Entity is a node.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	getTypeClass() Gets the type class.
static EntityType	parseEntityType(java.lang.String input) Parses the entity type.
java.lang.String	toKey() Returns the key of this type as string.
PropertyType	toPropertyType() Converts this entity type to a PropertyType.
java.lang.String	toString()
static EntityType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EntityType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EDGE

public static final EntityType EDGE

Entity is a edge.

ROW

public static final EntityType ROW

Entity is a row.

VERTEX

public static final EntityType VERTEX

Entity is a node.

Method Detail

getTypeClass

public java.lang.Class<?> getTypeClass()

Description copied from interface: Type

Gets the type class.

Specified by:

getTypeClass in interface Type

Returns:

the Java class this type maps to

parseEntityType

public static EntityType parseEntityType(java.lang.String input)

Parses the entity type.

Parameters:

input - the string input

Returns:

the entity type

toKey

public java.lang.String toKey()

Description copied from interface: Type

Returns the key of this type as string.

Specified by:

toKey in interface Type

Returns:

a JSON string representation of this type

toPropertyType

public PropertyType toPropertyType()

Converts this entity type to a PropertyType.

Returns:

A PropertyType matching this entity type.

Throws:

oracle.pgx.common.IllegalEnumConstantException - if this entity type cannot be converted.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<EntityType>

valueOf

public static EntityType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static EntityType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EntityType c : EntityType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared