org.opends.server.schema
Class BooleanSyntax

java.lang.Object
  extended by org.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>
      extended by 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.


Field Summary
static AttributeValueDecoder<java.lang.Boolean> DECODER
          A Boolean attribute value decoder for this syntax.
 
Constructor Summary
BooleanSyntax()
          Creates a new instance of this syntax.
 
Method Summary
static AttributeValue createBooleanValue(boolean b)
          Retrieves an attribute value containing a representation of the provided boolean value.
static boolean decodeBooleanValue(ByteString normalizedValue)
          Decodes the provided normalized value as a boolean.
 ApproximateMatchingRule getApproximateMatchingRule()
          Retrieves the default approximate matching rule that will be used for attributes with this syntax.
 java.lang.String getDescription()
          Retrieves a description for this attribute syntax.
 EqualityMatchingRule getEqualityMatchingRule()
          Retrieves the default equality matching rule that will be used for attributes with this syntax.
 java.lang.String getOID()
          Retrieves the OID for this attribute syntax.
 OrderingMatchingRule getOrderingMatchingRule()
          Retrieves the default ordering matching rule that will be used for attributes with this syntax.
 SubstringMatchingRule getSubstringMatchingRule()
          Retrieves the default substring matching rule that will be used for attributes with this syntax.
 java.lang.String getSyntaxName()
          Retrieves the common name for this attribute syntax.
 void initializeSyntax(AttributeSyntaxCfg configuration)
          Initializes this attribute syntax based on the information in the provided configuration entry.
 boolean valueIsAcceptable(ByteString value, MessageBuilder invalidReason)
          Indicates whether the provided value is acceptable for use in an attribute with this syntax.
 
Methods inherited from class org.opends.server.api.AttributeSyntax
equals, finalizeSyntax, hashCode, isConfigurationAcceptable, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DECODER

public static final AttributeValueDecoder<java.lang.Boolean> DECODER
A Boolean attribute value decoder for this syntax.

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

initializeSyntax

public void initializeSyntax(AttributeSyntaxCfg configuration)
                      throws ConfigException
Initializes this attribute syntax based on the information in the provided configuration entry.

Specified by:
initializeSyntax in class AttributeSyntax<AttributeSyntaxCfg>
Parameters:
configuration - The configuration to use to initialize this attribute syntax.
Throws:
ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

getSyntaxName

public java.lang.String getSyntaxName()
Retrieves the common name for this attribute syntax.

Specified by:
getSyntaxName in class AttributeSyntax<AttributeSyntaxCfg>
Returns:
The common name for this attribute syntax.

getOID

public java.lang.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 java.lang.String getDescription()
Retrieves a description for this attribute syntax.

Specified by:
getDescription in class AttributeSyntax<AttributeSyntaxCfg>
Returns:
A description for this attribute syntax.

getEqualityMatchingRule

public EqualityMatchingRule getEqualityMatchingRule()
Retrieves the default equality matching rule that will be used for attributes with this syntax.

Specified by:
getEqualityMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>
Returns:
The default equality matching rule that will be used for attributes with this syntax, or null if equality matches will not be allowed for this type by default.

getOrderingMatchingRule

public OrderingMatchingRule getOrderingMatchingRule()
Retrieves the default ordering matching rule that will be used for attributes with this syntax.

Specified by:
getOrderingMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>
Returns:
The default ordering matching rule that will be used for attributes with this syntax, or null if ordering matches will not be allowed for this type by default.

getSubstringMatchingRule

public SubstringMatchingRule getSubstringMatchingRule()
Retrieves the default substring matching rule that will be used for attributes with this syntax.

Specified by:
getSubstringMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>
Returns:
The default substring matching rule that will be used for attributes with this syntax, or null if substring matches will not be allowed for this type by default.

getApproximateMatchingRule

public ApproximateMatchingRule getApproximateMatchingRule()
Retrieves the default approximate matching rule that will be used for attributes with this syntax.

Specified by:
getApproximateMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>
Returns:
The default approximate matching rule that will be used for attributes with this syntax, or null if approximate matches will not be allowed for this type by default.

valueIsAcceptable

public boolean valueIsAcceptable(ByteString value,
                                 MessageBuilder invalidReason)
Indicates whether the provided value is acceptable for use in an attribute with this syntax. If it is not, then the reason may be appended to the provided buffer.

Specified by:
valueIsAcceptable in class AttributeSyntax<AttributeSyntaxCfg>
Parameters:
value - The value for which to make the determination.
invalidReason - The buffer to which the invalid reason should be appended.
Returns:
true if the provided value is acceptable for use with this syntax, or false if not.

createBooleanValue

public static AttributeValue 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.

decodeBooleanValue

public static boolean decodeBooleanValue(ByteString normalizedValue)
                                  throws DirectoryException
Decodes the provided normalized value as a boolean.

Parameters:
normalizedValue - The normalized value to decode as a boolean.
Returns:
The decoded boolean value.
Throws:
DirectoryException - If the provided value cannot be decoded as a boolean.