com.attivio.sdk.security

Enum AttivioPrincipal.PrincipalType

java.lang.Object

java.lang.Enum<AttivioPrincipal.PrincipalType>

com.attivio.sdk.security.AttivioPrincipal.PrincipalType

All Implemented Interfaces:

Serializable, Comparable<AttivioPrincipal.PrincipalType>

Enclosing class:

AttivioPrincipal

public static enum AttivioPrincipal.PrincipalType
extends Enum<AttivioPrincipal.PrincipalType>

Contains the possible principal types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GROUP The 'group' principal type.
UNKNOWN The 'unknown' principal type.
USER The 'user' principal type.

Method Summary

Modifier and Type	Method and Description
static AttivioPrincipal.PrincipalType	fromExternal(String value) Converts an external value to a PrincipalType value.
String	toString() Returns a string representation of the enumeration member.
static AttivioPrincipal.PrincipalType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AttivioPrincipal.PrincipalType[]	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

USER

public static final AttivioPrincipal.PrincipalType USER

The 'user' principal type.

GROUP

public static final AttivioPrincipal.PrincipalType GROUP

The 'group' principal type.

UNKNOWN

public static final AttivioPrincipal.PrincipalType UNKNOWN

The 'unknown' principal type.

Method Detail

values

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

Returns:

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

valueOf

public static AttivioPrincipal.PrincipalType 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

fromExternal

public static AttivioPrincipal.PrincipalType fromExternal(String value)

Converts an external value to a PrincipalType value.

Parameters:

value - the external value

Returns:

the type

Throws:

IllegalArgumentException - if an invalid principal type is passed in

toString

public String toString()

Returns a string representation of the enumeration member.

Overrides:

toString in class Enum<AttivioPrincipal.PrincipalType>

Returns:

the string representation of the enumeration member