Package com.yetanalytics.xapi.model

Enum ObjectType

java.lang.Object

java.lang.Enum<ObjectType>

com.yetanalytics.xapi.model.ObjectType

All Implemented Interfaces:

Serializable, Comparable<ObjectType>

public enum ObjectType
extends Enum<ObjectType>

Enumeration representing all Object Types in the 9274.1.1 xAPI Specification.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVITY
AGENT
GROUP
STATEMENT_REF
SUB_STATEMENT

Method Summary

Modifier and Type	Method	Description
static ObjectType	getByDisplayName(String name)	Retrieves the ObjectType for a given displayName
boolean	matches(String match)	Helper method for testing string equivalence to an ObjectType
String	toString()
static ObjectType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ObjectType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STATEMENT_REF

public static final ObjectType STATEMENT_REF

ACTIVITY

public static final ObjectType ACTIVITY

SUB_STATEMENT

public static final ObjectType SUB_STATEMENT

AGENT

public static final ObjectType AGENT

GROUP

public static final ObjectType GROUP

Method Detail

values

public static ObjectType[] 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 (ObjectType c : ObjectType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ObjectType valueOf(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:

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

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ObjectType>

Returns:

Display name of the ObjectType (used in JSON/Serialization)

getByDisplayName

public static ObjectType getByDisplayName(String name)

Retrieves the ObjectType for a given displayName

Parameters:

name - display name to look up correct ObjectType

Returns:

Appropriate ObjectType for the displayName

matches

public boolean matches(String match)

Helper method for testing string equivalence to an ObjectType

Parameters:

match - string to test for ObjectType equivalence

Returns:

boolean representing equivalence