Package org.ldaptive.schema
Class AttributeType
java.lang.Object
org.ldaptive.schema.AbstractSchemaElement
org.ldaptive.schema.AbstractNamedSchemaElement
org.ldaptive.schema.AttributeType
- All Implemented Interfaces:
SchemaElement
Bean for an attribute type schema element.
AttributeTypeDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active [ SP "SUP" SP oid ] ; supertype [ SP "EQUALITY" SP oid ] ; equality matching rule [ SP "ORDERING" SP oid ] ; ordering matching rule [ SP "SUBSTR" SP oid ] ; substrings matching rule [ SP "SYNTAX" SP noidlen ] ; value syntax [ SP "SINGLE-VALUE" ] ; single-value [ SP "COLLECTIVE" ] ; collective [ SP "NO-USER-MODIFICATION" ] ; not user modifiable [ SP "USAGE" SP usage ] ; usage extensions WSP RPAREN ; extensions
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Parses an attribute type definition using a char buffer.static class
Parses an attribute type definition using a regular expression. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Collective.private String
Equality matching rule.private static final int
hash code seed.private boolean
No user modification.private final String
OID.private String
Ordering matching rule.private boolean
Single valued.private String
Substring matching rule.private String
Superior type.private String
Syntax OID.private AttributeUsage
Usage. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new attribute type.AttributeType
(String oid, String[] names, String description, boolean obsolete, String superiorType, String equalityMatchingRule, String orderingMatchingRule, String substringMatchingRule, String syntaxOID, boolean singleValued, boolean collective, boolean noUserModification, AttributeUsage usage, Extensions extensions) Creates a new attribute type. -
Method Summary
Modifier and TypeMethodDescriptionboolean
format()
Returns this schema element as formatted string per RFC 4512.Returns the equality matching rule.getOID()
Returns the oid.Returns the ordering matching rule.Returns the substring matching rule.Returns the superior type.Returns the syntax oid.getSyntaxOID
(boolean withBoundCount) Returns the syntax oid.int
Returns the syntax oid bound count.getUsage()
Returns the usage.int
hashCode()
boolean
Returns whether this attribute type is collective.boolean
Returns whether this attribute type allows user modification.boolean
Returns whether this attribute type is single valued.static AttributeType
Parses the supplied definition string and creates an initialized attribute type.void
setCollective
(boolean b) Sets whether this attribute type is collective.void
Sets the equality matching rule.void
setNoUserModification
(boolean b) Sets whether this attribute type allows user modification.void
Sets the ordering matching rule.void
setSingleValued
(boolean b) Sets whether this attribute type is single valued.void
Sets the substring matching rule.void
Sets the superior type.void
Sets the syntax oid.void
Sets the usage.toString()
Methods inherited from class org.ldaptive.schema.AbstractNamedSchemaElement
getName, getNames, hasName, isObsolete, setNames, setObsolete
Methods inherited from class org.ldaptive.schema.AbstractSchemaElement
containsBooleanExtension, getDescription, getExtensions, setDescription, setExtensions
-
Field Details
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
oid
OID. -
superiorType
Superior type. -
equalityMatchingRule
Equality matching rule. -
orderingMatchingRule
Ordering matching rule. -
substringMatchingRule
Substring matching rule. -
syntaxOID
Syntax OID. -
singleValued
private boolean singleValuedSingle valued. -
collective
private boolean collectiveCollective. -
noUserModification
private boolean noUserModificationNo user modification. -
usage
Usage.
-
-
Constructor Details
-
AttributeType
Creates a new attribute type.- Parameters:
s
- oid
-
AttributeType
public AttributeType(String oid, String[] names, String description, boolean obsolete, String superiorType, String equalityMatchingRule, String orderingMatchingRule, String substringMatchingRule, String syntaxOID, boolean singleValued, boolean collective, boolean noUserModification, AttributeUsage usage, Extensions extensions) Creates a new attribute type.- Parameters:
oid
- oidnames
- namesdescription
- descriptionobsolete
- obsoletesuperiorType
- superior typeequalityMatchingRule
- equality matching ruleorderingMatchingRule
- ordering matching rulesubstringMatchingRule
- substring matching rulesyntaxOID
- syntax OIDsingleValued
- single valuedcollective
- collectivenoUserModification
- no user modificationusage
- usageextensions
- extensions
-
-
Method Details
-
getOID
Returns the oid.- Returns:
- oid
-
getSuperiorType
Returns the superior type.- Returns:
- superior type
-
setSuperiorType
Sets the superior type.- Parameters:
s
- superior type
-
getEqualityMatchingRule
Returns the equality matching rule.- Returns:
- equality matching rule
-
setEqualityMatchingRule
Sets the equality matching rule.- Parameters:
s
- equality matching rule
-
getOrderingMatchingRule
Returns the ordering matching rule.- Returns:
- ordering matching rule
-
setOrderingMatchingRule
Sets the ordering matching rule.- Parameters:
s
- ordering matching rule
-
getSubstringMatchingRule
Returns the substring matching rule.- Returns:
- substring matching rule
-
setSubstringMatchingRule
Sets the substring matching rule.- Parameters:
s
- substring matching rule
-
getSyntaxOID
Returns the syntax oid.- Returns:
- syntax oid
-
getSyntaxOID
Returns the syntax oid.- Parameters:
withBoundCount
- whether the bound count should be included- Returns:
- syntax oid
-
getSyntaxOIDBoundCount
public int getSyntaxOIDBoundCount()Returns the syntax oid bound count.- Returns:
- syntax oid bound count
-
setSyntaxOID
Sets the syntax oid.- Parameters:
s
- syntax oid
-
isSingleValued
public boolean isSingleValued()Returns whether this attribute type is single valued.- Returns:
- whether this attribute type is single valued
-
setSingleValued
public void setSingleValued(boolean b) Sets whether this attribute type is single valued.- Parameters:
b
- whether this attribute type is single valued
-
isCollective
public boolean isCollective()Returns whether this attribute type is collective.- Returns:
- whether this attribute type is collective
-
setCollective
public void setCollective(boolean b) Sets whether this attribute type is collective.- Parameters:
b
- whether this attribute type is collective
-
isNoUserModification
public boolean isNoUserModification()Returns whether this attribute type allows user modification.- Returns:
- whether this attribute type allows user modification
-
setNoUserModification
public void setNoUserModification(boolean b) Sets whether this attribute type allows user modification.- Parameters:
b
- whether this attribute type allows user modification
-
getUsage
Returns the usage.- Returns:
- usage
-
setUsage
Sets the usage.- Parameters:
u
- attribute usage
-
parse
Parses the supplied definition string and creates an initialized attribute type.- Parameters:
definition
- to parse- Returns:
- attribute type
- Throws:
SchemaParseException
- if the supplied definition is invalid
-
format
Description copied from interface:SchemaElement
Returns this schema element as formatted string per RFC 4512.- Returns:
- formatted string
-
equals
- Overrides:
equals
in classAbstractSchemaElement
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractSchemaElement
-
toString
-