Package com.sun.identity.sm

Enum AttributeSchema.Syntax

java.lang.Object

java.lang.Enum<AttributeSchema.Syntax>

com.sun.identity.sm.AttributeSchema.Syntax

All Implemented Interfaces:

Serializable, Comparable<AttributeSchema.Syntax>

Enclosing class:

AttributeSchema

public static enum AttributeSchema.Syntax
extends Enum<AttributeSchema.Syntax>

The class Syntax defines the syntax of the schema attributes and provides static constants for these types. In other words, this class defines the primitive data types for the schema attributes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOLEAN	The BOOLEAN attribute syntax specifies that the attribute is of boolean type, i.e., can have a value of either true or false
DATE	The DATE attribute syntax specifies that the attribute is of date type.
DATE_TIME	The DATE_TIME attribute syntax specifies that the attribute is a date time field.
DECIMAL	The DECIMAL attribute syntax specifies that the attribute is a decimal value.
DECIMAL_NUMBER	The DECIMAL_NUMBER attribute syntax specifies that the attribute is a floating point number, e.g., 1.5, 3.56, etc.
DECIMAL_RANGE	The DECIMAL_RANGE attribute syntax specifies that the attribute is a decimal number within a range.
DN	The DN attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).
EMAIL	The EMAIL attribute syntax specifies that the attribute is a email address.
ENCRYPTED_PASSWORD	The ENCRYPTED PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.
JSON	The JSON attribute syntax specifies that the attribute is of JSON type, i.e., in json formatted string.
NUMBER	The NUMBER attribute syntax specifies that the attribute is a number.
NUMBER_RANGE	The NUMBER_RANGE attribute syntax specifies that the attribute is a number within a range.
NUMERIC	The NUMERIC attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.
PARAGRAPH	The PARAGRAPH attribute syntax specifies that the attribute is of multi-lined text type.
PASSWORD	The PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.
PERCENT	The PERCENT attribute syntax specifies that the attribute is a percentage.
SCRIPT	The SCRIPT attribute syntax specifies that the attribute is of multi-lined text type and more specifically a script.
STRING	The STRING attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters.
URL	The URL attribute syntax specifies that the attribute is a URL.
XML	The XML attribute syntax specifies that the attribute is of XML type, i.e., can have any unicode characters.

Method Summary

Modifier and Type	Method	Description
String	toString()	The method returns the string representation of the schema attribute syntax.
static AttributeSchema.Syntax	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AttributeSchema.Syntax[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOLEAN

public static final AttributeSchema.Syntax BOOLEAN

The BOOLEAN attribute syntax specifies that the attribute is of boolean type, i.e., can have a value of either true or false

EMAIL

public static final AttributeSchema.Syntax EMAIL

The EMAIL attribute syntax specifies that the attribute is a email address.

URL

public static final AttributeSchema.Syntax URL

The URL attribute syntax specifies that the attribute is a URL.

STRING

public static final AttributeSchema.Syntax STRING

The STRING attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters.

PARAGRAPH

public static final AttributeSchema.Syntax PARAGRAPH

The PARAGRAPH attribute syntax specifies that the attribute is of multi-lined text type.

XML

public static final AttributeSchema.Syntax XML

The XML attribute syntax specifies that the attribute is of XML type, i.e., can have any unicode characters.

JSON

public static final AttributeSchema.Syntax JSON

The JSON attribute syntax specifies that the attribute is of JSON type, i.e., in json formatted string.

SCRIPT

public static final AttributeSchema.Syntax SCRIPT

The SCRIPT attribute syntax specifies that the attribute is of multi-lined text type and more specifically a script.

PASSWORD

public static final AttributeSchema.Syntax PASSWORD

The PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.

ENCRYPTED_PASSWORD

public static final AttributeSchema.Syntax ENCRYPTED_PASSWORD

The ENCRYPTED PASSWORD attribute syntax specifies that the attribute is of password type, will be used by UI to mask the password typed.

DATE

public static final AttributeSchema.Syntax DATE

The DATE attribute syntax specifies that the attribute is of date type.

NUMERIC

public static final AttributeSchema.Syntax NUMERIC

The NUMERIC attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.

NUMBER

public static final AttributeSchema.Syntax NUMBER

The NUMBER attribute syntax specifies that the attribute is a number.

DECIMAL

public static final AttributeSchema.Syntax DECIMAL

The DECIMAL attribute syntax specifies that the attribute is a decimal value.

PERCENT

public static final AttributeSchema.Syntax PERCENT

The PERCENT attribute syntax specifies that the attribute is a percentage.

NUMBER_RANGE

public static final AttributeSchema.Syntax NUMBER_RANGE

The NUMBER_RANGE attribute syntax specifies that the attribute is a number within a range.

DECIMAL_RANGE

public static final AttributeSchema.Syntax DECIMAL_RANGE

The DECIMAL_RANGE attribute syntax specifies that the attribute is a decimal number within a range.

DECIMAL_NUMBER

public static final AttributeSchema.Syntax DECIMAL_NUMBER

The DECIMAL_NUMBER attribute syntax specifies that the attribute is a floating point number, e.g., 1.5, 3.56, etc.

DN

public static final AttributeSchema.Syntax DN

The DN attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).

DATE_TIME

public static final AttributeSchema.Syntax DATE_TIME

The DATE_TIME attribute syntax specifies that the attribute is a date time field.

Method Detail

values

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

Returns:

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

valueOf

public static AttributeSchema.Syntax 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

toString

public String toString()

The method returns the string representation of the schema attribute syntax.

Overrides:

toString in class Enum<AttributeSchema.Syntax>

Returns:

String string representation of schema attribute syntax