ca.tnt.ldaputils.annotations
Enum ObjectClassType

java.lang.Object
  java.lang.Enum<ObjectClassType>
      ca.tnt.ldaputils.annotations.ObjectClassType

All Implemented Interfaces:

Serializable, Comparable<ObjectClassType>

public enum ObjectClassType
extends Enum<ObjectClassType>

Defines the types of LDAP objectClass(es). There are essentially two types: STRUCTURAL, and AUXILIARY.

Created : 10-Dec-2010 4:00:38 PM MST

Author:

Trenton D. Adams

Enum Constant Summary

AUXILIARY
An Auxiliary ldap objectclass is just an add-on to the entry.

STRUCTURAL
a structural ldap objectClass is one that provides the base attribute definitions for an ldap entry.

Method Summary

static ObjectClassType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ObjectClassType[]	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

AUXILIARY

public static final ObjectClassType AUXILIARY

An Auxiliary ldap objectclass is just an add-on to the entry. For example, you might define an ldap entry as having the objectClass of "labeledURIObject", which simply means that entry can now accept web site urls with a space separated description.

STRUCTURAL

public static final ObjectClassType STRUCTURAL

a structural ldap objectClass is one that provides the base attribute definitions for an ldap entry. It can be supplemented by an AUXILIARY objectClass, as defined in AUXILIARY. Or, it can be a hierarchy of structural objectClass(es). A good example of this type of objectClass is the "person" objectClass. A good example of hierarchical structural objectClasses are the inetOrgPerson -> organizationalPerson -> person object classes, where person is the base most class.

Method Detail

values

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

Returns:

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

valueOf

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