Package org.apache.directory.api.ldap.model.schema

Enum ObjectClassTypeEnum

java.lang.Object

java.lang.Enum<ObjectClassTypeEnum>

org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum

All Implemented Interfaces:

Serializable, Comparable<ObjectClassTypeEnum>

public enum ObjectClassTypeEnum
extends Enum<ObjectClassTypeEnum>

Type safe enumerations for an objectClass' type. An ObjectClass type can be one of the following types:

• ABSTRACT
• AUXILIARY
• STRUCTURAL

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSTRACT	The enumeration constant value for the abstract objectClasses
AUXILIARY	The enumeration constant value for the auxillary objectClasses
STRUCTURAL	The enumeration constant value for the structural objectClasses

Field Summary

Fields

Modifier and Type	Field	Description
static int	ABSTRACT_VAL	The int constant value for the abstract objectClasses
static int	AUXILIARY_VAL	The int constant value for the auxillary objectClasses
static int	STRUCTURAL_VAL	The int constant value for the structural objectClasses

Method Summary

Modifier and Type	Method	Description
static ObjectClassTypeEnum	getClassType(String name)	Gets the objectClass type enumeration of AUXILIARY, STRUCTURAL, or, ABSTRACT.
int	getValue()
static ObjectClassTypeEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ObjectClassTypeEnum[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABSTRACT

public static final ObjectClassTypeEnum ABSTRACT

The enumeration constant value for the abstract objectClasses

AUXILIARY

public static final ObjectClassTypeEnum AUXILIARY

The enumeration constant value for the auxillary objectClasses

STRUCTURAL

public static final ObjectClassTypeEnum STRUCTURAL

The enumeration constant value for the structural objectClasses

Field Detail

ABSTRACT_VAL

public static final int ABSTRACT_VAL

The int constant value for the abstract objectClasses

See Also:

Constant Field Values

AUXILIARY_VAL

public static final int AUXILIARY_VAL

The int constant value for the auxillary objectClasses

See Also:

Constant Field Values

STRUCTURAL_VAL

public static final int STRUCTURAL_VAL

The int constant value for the structural objectClasses

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Returns:

The value associated with the current element.

getClassType

public static ObjectClassTypeEnum getClassType(String name)

Gets the objectClass type enumeration of AUXILIARY, STRUCTURAL, or, ABSTRACT.

Parameters:

name - options are AUXILIARY, STRUCTURAL, or, ABSTRACT

Returns:

the type safe enumeration for the objectClass type