AttributeSchema.Syntax (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.sm.AttributeSchema.Syntax

Enclosing class:

AttributeSchema
```
public static class AttributeSchema.Syntax
extends Object
```
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.

Field Summary

Fields
Modifier and Type	Field and Description
`static 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`
`static AttributeSchema.Syntax`	`DATE` The `DATE` attribute syntax specifies that the attribute is of date type.
`static AttributeSchema.Syntax`	`DECIMAL` The `DECIMAL` attribute syntax specifies that the attribute is a decimal value.
`static 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.
`static AttributeSchema.Syntax`	`DECIMAL_RANGE` The `DECIMAL_RANGE` attribute syntax specifies that the attribute is a decimal number within a range.
`static AttributeSchema.Syntax`	`DN` The `DN` attribute syntax specifies that the attribute should be an LDAP distinguished name (DN).
`static AttributeSchema.Syntax`	`EMAIL` The `EMAIL` attribute syntax specifies that the attribute is a email address.
`static 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.
`static AttributeSchema.Syntax`	`NUMBER` The `NUMBER` attribute syntax specifies that the attribute is a number.
`static AttributeSchema.Syntax`	`NUMBER_RANGE` The `NUMBER_RANGE` attribute syntax specifies that the attribute is a number within a range.
`static AttributeSchema.Syntax`	`NUMERIC` The `NUMERIC` attribute syntax specifies that the attribute is numeric, i.e., can have numbers only.
`static AttributeSchema.Syntax`	`PARAGRAPH` The `PARAGRAPH` attribute syntax specifies that the attribute is of multi-lined text type.
`static 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.
`static AttributeSchema.Syntax`	`PERCENT` The `PERCENT` attribute syntax specifies that the attribute is a percentage.
`static AttributeSchema.Syntax`	`SCRIPT` The `SCRIPT` attribute syntax specifies that the attribute is of multi-lined text type and more specifically a script.
`static AttributeSchema.Syntax`	`STRING` The `STRING` attribute syntax specifies that the attribute is of text type, i.e., can have any unicode characters.
`static AttributeSchema.Syntax`	`URL` The `URL` attribute syntax specifies that the attribute is a URL.
`static AttributeSchema.Syntax`	`XML` The `XML` attribute syntax specifies that the attribute is of XML type, i.e., can have any unicode characters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object schemaAttrSyntax)` Method to check if two schema attribute syntax are equal.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` The method returns the string representation of the schema attribute syntax.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field 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.
  - 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).
- Method Detail
  - toString
```
public String toString()
```
    The method returns the string representation of the schema attribute syntax.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String string representation of schema attribute syntax
  - equals
```
public boolean equals(Object schemaAttrSyntax)
```
    Method to check if two schema attribute syntax are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    schemaAttrSyntax - the reference object with which to compare
    
    Returns:
    
    true if the objects are same; false otherwise
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object

Class AttributeSchema.Syntax

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOOLEAN

EMAIL

URL

STRING

PARAGRAPH

XML

SCRIPT

PASSWORD

ENCRYPTED_PASSWORD

DATE

NUMERIC

NUMBER

DECIMAL

PERCENT

NUMBER_RANGE

DECIMAL_RANGE

DECIMAL_NUMBER

DN

Method Detail

toString

equals

hashCode