|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.AttributeSyntax<T>
T
- The type of configuration handled by this attribute
syntax.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class AttributeSyntax<T extends AttributeSyntaxCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements an attribute syntax.
Constructor Summary | |
---|---|
AttributeSyntax()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this attribute syntax. |
void |
finalizeSyntax()
Performs any finalization that may be necessary for this attribute syntax. |
abstract ApproximateMatchingRule |
getApproximateMatchingRule()
Retrieves the default approximate matching rule that will be used for attributes with this syntax. |
abstract java.lang.String |
getDescription()
Retrieves a description for this attribute syntax. |
abstract EqualityMatchingRule |
getEqualityMatchingRule()
Retrieves the default equality matching rule that will be used for attributes with this syntax. |
abstract java.lang.String |
getOID()
Retrieves the OID for this attribute syntax. |
abstract OrderingMatchingRule |
getOrderingMatchingRule()
Retrieves the default ordering matching rule that will be used for attributes with this syntax. |
abstract SubstringMatchingRule |
getSubstringMatchingRule()
Retrieves the default substring matching rule that will be used for attributes with this syntax. |
abstract java.lang.String |
getSyntaxName()
Retrieves the common name for this attribute syntax. |
int |
hashCode()
Retrieves the hash code for this attribute syntax. |
abstract void |
initializeSyntax(T configuration)
Initializes this attribute syntax based on the information in the provided configuration entry. |
boolean |
isConfigurationAcceptable(AttributeSyntaxCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this attribute syntax. |
java.lang.String |
toString()
Retrieves a string representation of this attribute syntax in the format defined in RFC 2252. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this attribute syntax in the format defined in RFC 2252 to the provided buffer. |
abstract 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 java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AttributeSyntax()
Method Detail |
---|
public abstract void initializeSyntax(T configuration) throws ConfigException, InitializationException
configuration
- The configuration to use to initialize
this attribute syntax.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.public boolean isConfigurationAcceptable(AttributeSyntaxCfg configuration, java.util.List<Message> unacceptableReasons)
configuration
- The attribute syntax configuration
for which to make the determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.
true
if the provided configuration is acceptable
for this attribute syntax, or false
if not.public void finalizeSyntax()
public abstract java.lang.String getSyntaxName()
public abstract java.lang.String getOID()
public abstract java.lang.String getDescription()
public abstract EqualityMatchingRule getEqualityMatchingRule()
null
if equality
matches will not be allowed for this type by default.public abstract OrderingMatchingRule getOrderingMatchingRule()
null
if ordering
matches will not be allowed for this type by default.public abstract SubstringMatchingRule getSubstringMatchingRule()
null
if
substring matches will not be allowed for this type by
default.public abstract ApproximateMatchingRule getApproximateMatchingRule()
null
if
approximate matches will not be allowed for this type by
default.public abstract boolean valueIsAcceptable(ByteString value, MessageBuilder invalidReason)
value
- The value for which to make the
determination.invalidReason
- The buffer to which the invalid reason
should be appended.
true
if the provided value is acceptable for use
with this syntax, or false
if not.public final int hashCode()
hashCode
in class java.lang.Object
public final boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is equal to this
attribute syntax, or false
if it is not.public final java.lang.String toString()
toString
in class java.lang.Object
public final void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |