com.geotab.model.entity.zone

Enum IncludeGroups

java.lang.Object

java.lang.Enum<IncludeGroups>

com.geotab.model.entity.zone.IncludeGroups

All Implemented Interfaces:

HasName, Serializable, Comparable<IncludeGroups>

public enum IncludeGroups
extends Enum<IncludeGroups>
implements HasName

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD Include Children groups in the query results.
DIRECT Directly related groups only in the query results.
PARENT Include Parent groups in the query results.
PARENT_AND_CHILD Include Parent and Children groups in the query results.
UNKNOWN Fallback when enumeration value is unknown.

Method Summary

Modifier and Type	Method and Description
String	getName()
static IncludeGroups	valueOf(String name) Returns the enum constant of this type with the specified name.
static IncludeGroups[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final IncludeGroups UNKNOWN

Fallback when enumeration value is unknown.

CHILD

public static final IncludeGroups CHILD

Include Children groups in the query results.

PARENT

public static final IncludeGroups PARENT

Include Parent groups in the query results.

PARENT_AND_CHILD

public static final IncludeGroups PARENT_AND_CHILD

Include Parent and Children groups in the query results.

DIRECT

public static final IncludeGroups DIRECT

Directly related groups only in the query results.

Method Detail

values

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

Returns:

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

valueOf

public static IncludeGroups 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

getName

public String getName()

Specified by:

getName in interface HasName