org.opends.server.schema

Class BooleanSyntax

java.lang.Object

org.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>

org.opends.server.schema.BooleanSyntax

public class BooleanSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class defines the Boolean attribute syntax, which only allows values of "TRUE" or "FALSE" (although this implementation is more flexible and will also allow "YES", "ON", or "1" instead of "TRUE", or "NO", "OFF", or "0" instead of "FALSE"). Only equality matching is allowed by default for this syntax.

Constructor Summary

Constructors

Constructor and Description
BooleanSyntax() Creates a new instance of this syntax.

Method Summary

Methods

Modifier and Type	Method and Description
static org.forgerock.opendj.ldap.ByteString	createBooleanValue(boolean b) Retrieves an attribute value containing a representation of the provided boolean value.
String	getDescription() Retrieves a description for this attribute syntax.
String	getName() Retrieves the common name for this attribute syntax.
String	getOID() Retrieves the OID for this attribute syntax.
org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.

Methods inherited from class org.opends.server.api.AttributeSyntax

equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, initializeSyntax, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BooleanSyntax

public BooleanSyntax()

Creates a new instance of this syntax. Note that the only thing that should be done here is to invoke the default constructor for the superclass. All initialization should be performed in the initializeSyntax method.

Method Detail

getSDKSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)

Returns the SDK Syntax equivalent to this syntax.

This method allow smooth migration to SDK syntax. It will disappear once the the migration to SDK schema is complete, together with this class and all its implementation.

Specified by:

getSDKSyntax in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

getName

public String getName()

Retrieves the common name for this attribute syntax.

Specified by:

getName in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The common name for this attribute syntax.

getOID

public String getOID()

Retrieves the OID for this attribute syntax.

Specified by:

getOID in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The OID for this attribute syntax.

getDescription

public String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

createBooleanValue

public static org.forgerock.opendj.ldap.ByteString createBooleanValue(boolean b)

Retrieves an attribute value containing a representation of the provided boolean value.

Parameters:

b - The boolean value for which to retrieve the attribute value.

Returns:

The attribute value created from the provided boolean value.