public class LdapSyntax extends AbstractSchemaObject
According to ldapbis [MODELS]:
4.1.5. LDAP Syntaxes LDAP Syntaxes of (attribute and assertion) values are described in terms of ASN.1 [X.680] and, optionally, have an octet string encoding known as the LDAP-specific encoding. Commonly, the LDAP-specific encoding is constrained to string of Universal Character Set (UCS) [ISO10646] characters in UTF-8 [UTF-8] form. Each LDAP syntax is identified by an object identifier (OID). LDAP syntax definitions are written according to the ABNF: SyntaxDescription = LPAREN WSP numericoid ; object identifier [ SP "DESC" SP qdstring ] ; description extensions WSP RPAREN ; extensions where: [numericoid] is object identifier assigned to this LDAP syntax; DESC [qdstring] is a short descriptive string; and [extensions] describe extensions.
DescriptionUtils#getDescription(Syntax)
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected boolean |
isHumanReadable
the human readable flag
|
static long |
serialVersionUID
The serialVersionUID
|
protected SyntaxChecker |
syntaxChecker
The associated SyntaxChecker
|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification
Constructor and Description |
---|
LdapSyntax(String oid)
Creates a Syntax object using a unique OID.
|
LdapSyntax(String oid,
String description)
Creates a Syntax object using a unique OID.
|
LdapSyntax(String oid,
String description,
boolean isHumanReadable)
Creates a Syntax object using a unique OID.
|
Modifier and Type | Method and Description |
---|---|
void |
addToRegistries(List<Throwable> errors,
Registries registries)
Inject the Syntax into the registries, updating the references to
other SchemaObject
|
void |
clear()
Clear the current SchemaObject : remove all the references to other objects,
and all the Maps.
|
LdapSyntax |
copy()
Copy a LdapSyntax
|
boolean |
equals(Object o) |
SyntaxChecker |
getSyntaxChecker()
Gets the SyntaxChecker used to validate values in accordance with this
Syntax.
|
boolean |
isHumanReadable()
Gets whether or not the Syntax is human readable.
|
void |
removeFromRegistries(List<Throwable> errors,
Registries registries)
Remove the SDyntax from the registries, updating the references to
other SchemaObject.
|
void |
setHumanReadable(boolean isHumanReadable)
Sets the human readable flag value.
|
void |
setSyntaxChecker(SyntaxChecker syntaxChecker)
Sets the associated SyntaxChecker
|
String |
toString() |
void |
updateSyntaxChecker(SyntaxChecker syntaxChecker)
Update the associated SyntaxChecker, even if the SchemaObject is readOnly
|
addExtension, addName, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification
public static final long serialVersionUID
protected boolean isHumanReadable
protected SyntaxChecker syntaxChecker
public LdapSyntax(String oid)
oid
- the OID for this Syntaxpublic LdapSyntax(String oid, String description)
oid
- the OID for this Syntaxpublic boolean isHumanReadable()
public void setHumanReadable(boolean isHumanReadable)
isHumanReadable
- the human readable flag value to setpublic SyntaxChecker getSyntaxChecker()
public void setSyntaxChecker(SyntaxChecker syntaxChecker)
syntaxChecker
- The associated SyntaxCheckerpublic void updateSyntaxChecker(SyntaxChecker syntaxChecker)
syntaxChecker
- The associated SyntaxCheckerpublic String toString()
toString
in class Object
Object.toString()
public void addToRegistries(List<Throwable> errors, Registries registries) throws LdapException
addToRegistries
in interface SchemaObject
addToRegistries
in class AbstractSchemaObject
registries
- The Registrieserrors
- The errors we gotIf
- the addition failedLdapException
public void removeFromRegistries(List<Throwable> errors, Registries registries) throws LdapException
removeFromRegistries
in interface SchemaObject
removeFromRegistries
in class AbstractSchemaObject
registries
- The Registrieserrors
- The errors we gotIf
- the Syntx is not validLdapException
public LdapSyntax copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(Object o)
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object#equals()
public void clear()
clear
in interface SchemaObject
clear
in class AbstractSchemaObject
Copyright © 2003–2015 The Apache Software Foundation. All rights reserved.