Package org.springframework.ldap.ldif.support

Enum Class LineIdentifier

java.lang.Object

java.lang.Enum<LineIdentifier>

org.springframework.ldap.ldif.support.LineIdentifier

All Implemented Interfaces:

Serializable, Comparable<LineIdentifier>, Constable

public enum LineIdentifier
extends Enum<LineIdentifier>

Enumeration declaring possible event types when parsing LDIF files.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Attribute	Signifies the event when a new attribute is encountered.
ChangeType	Record being parsed is a 'changetype' record.
Comment	The current line is a comment and should be ignored.
Continuation	Indicates the current line parsed is a continuation of the previous line.
Control	An LDAP changetype control was encountered.
EndOfRecord	Signals the end of record has been reached.
NewRecord	Signifies the start of a new record in the file has been encountered: a DN declaration.
VersionIdentifier	Every LDIF file may optionally start with a version identifier of the form 'version: 1'.
Void	Parsed line should be ignored - used to skip remaining lines in a 'changetype' record.

Method Summary

Modifier and Type	Method	Description
static LineIdentifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LineIdentifier[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VersionIdentifier

public static final LineIdentifier VersionIdentifier

Every LDIF file may optionally start with a version identifier of the form 'version: 1'.

NewRecord

public static final LineIdentifier NewRecord

Signifies the start of a new record in the file has been encountered: a DN declaration.

EndOfRecord

public static final LineIdentifier EndOfRecord

Signals the end of record has been reached.

Attribute

public static final LineIdentifier Attribute

Signifies the event when a new attribute is encountered.

Continuation

public static final LineIdentifier Continuation

Indicates the current line parsed is a continuation of the previous line.

Comment

public static final LineIdentifier Comment

The current line is a comment and should be ignored.

Control

public static final LineIdentifier Control

An LDAP changetype control was encountered.

ChangeType

public static final LineIdentifier ChangeType

Record being parsed is a 'changetype' record.

Void

public static final LineIdentifier Void

Parsed line should be ignored - used to skip remaining lines in a 'changetype' record.

Method Details

values

public static LineIdentifier[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LineIdentifier valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null