com.unboundid.ldif

Enum DuplicateValueBehavior

java.lang.Object

java.lang.Enum<DuplicateValueBehavior>

com.unboundid.ldif.DuplicateValueBehavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DuplicateValueBehavior>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum DuplicateValueBehavior
extends java.lang.Enum<DuplicateValueBehavior>

This enum defines a set of possible behaviors that may be exhibited by the LDIF reader when encountering entries with duplicate attribute values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REJECT Indicates that any entry containing duplicate attribute values should be rejected.
RETAIN Indicates that duplicate values should be retained, so that the resulting entry may have multiple copies of the value.
STRIP Indicates that duplicate values should be stripped, so that the resulting entry will have only one copy of the value.

Method Summary

Modifier and Type	Method and Description
static DuplicateValueBehavior	forName(java.lang.String name) Retrieves the duplicate value behavior with the specified name.
static DuplicateValueBehavior	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DuplicateValueBehavior[]	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

STRIP

public static final DuplicateValueBehavior STRIP

Indicates that duplicate values should be stripped, so that the resulting entry will have only one copy of the value.

RETAIN

public static final DuplicateValueBehavior RETAIN

Indicates that duplicate values should be retained, so that the resulting entry may have multiple copies of the value. This is illegal and may cause significant problems with attempts to use the resulting entry.

REJECT

public static final DuplicateValueBehavior REJECT

Indicates that any entry containing duplicate attribute values should be rejected.

Method Detail

values

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

Returns:

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

valueOf

public static DuplicateValueBehavior valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

forName

@Nullable
public static DuplicateValueBehavior forName(@NotNull
                                                       java.lang.String name)

Retrieves the duplicate value behavior with the specified name.

Parameters:

name - The name of the duplicate value behavior to retrieve. It must not be null.

Returns:

The requested duplicate value behavior, or null if no such behavior is defined.