org.opends.server.authorization.dseecompat
Enum EnumTargetKeyword

java.lang.Object
  java.lang.Enum<EnumTargetKeyword>
      org.opends.server.authorization.dseecompat.EnumTargetKeyword

All Implemented Interfaces:

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

public enum EnumTargetKeyword
extends java.lang.Enum<EnumTargetKeyword>

This class provides an enumeration of the valid ACI target keywords.

Enum Constant Summary

KEYWORD_EXTOP
This enumeration is returned when the target keyword is "extop".

KEYWORD_TARGATTRFILTERS
This enumeration is returned when the target keyword is "targattrfilters".

KEYWORD_TARGET
This enumeration is returned when the target keyword is "target".

KEYWORD_TARGETATTR
This enumeration is returned when the target keyword is "targetattr".

KEYWORD_TARGETCONTROL
This enumeration is returned when the target keyword is "targetcontrol".

KEYWORD_TARGETFILTER
This enumeration is returned when the target keyword is "targetfilter".

KEYWORD_TARGETSCOPE
This enumeration is returned when the target keyword is "targetscope".

Method Summary

static EnumTargetKeyword	createKeyword(java.lang.String keyword) Create an enumeration of the provided keyword name.
java.lang.String	getKeyword() Return the enumeration keyword name.
boolean	isKeyword(java.lang.String keyword) Checks if the keyword name is equal to the enumeration name.
static EnumTargetKeyword	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumTargetKeyword[]	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

KEYWORD_TARGET

public static final EnumTargetKeyword KEYWORD_TARGET

This enumeration is returned when the target keyword is "target".

KEYWORD_TARGETATTR

public static final EnumTargetKeyword KEYWORD_TARGETATTR

This enumeration is returned when the target keyword is "targetattr".

KEYWORD_TARGETSCOPE

public static final EnumTargetKeyword KEYWORD_TARGETSCOPE

This enumeration is returned when the target keyword is "targetscope".

KEYWORD_TARGETFILTER

public static final EnumTargetKeyword KEYWORD_TARGETFILTER

This enumeration is returned when the target keyword is "targetfilter".

KEYWORD_TARGATTRFILTERS

public static final EnumTargetKeyword KEYWORD_TARGATTRFILTERS

This enumeration is returned when the target keyword is "targattrfilters".

KEYWORD_TARGETCONTROL

public static final EnumTargetKeyword KEYWORD_TARGETCONTROL

This enumeration is returned when the target keyword is "targetcontrol".

KEYWORD_EXTOP

public static final EnumTargetKeyword KEYWORD_EXTOP

This enumeration is returned when the target keyword is "extop".

Method Detail

values

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

Returns:

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

valueOf

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

isKeyword

public boolean isKeyword(java.lang.String keyword)

Checks if the keyword name is equal to the enumeration name.

Parameters:

keyword - The keyword name to check.

Returns:

True if the keyword name is equal to the enumeration.

createKeyword

public static EnumTargetKeyword createKeyword(java.lang.String keyword)

Create an enumeration of the provided keyword name.

Parameters:

keyword - The keyword name to create.

Returns:

An enumeration of the specified keyword name or null if the keyword name is invalid.

getKeyword

public java.lang.String getKeyword()

Return the enumeration keyword name.

Returns:

The keyword name.