public final class AttributeType extends Object implements Comparable<AttributeType>
Where ordered sets of names, or extra properties are provided, the ordering
will be preserved when the associated fields are accessed via their getters
or via the toString()
methods.
Modifier and Type | Class and Description |
---|---|
static class |
AttributeType.Builder
A fluent API for incrementally constructing attribute type.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(AttributeType type)
Compares this attribute type to the provided attribute type.
|
boolean |
equals(Object o)
Returns
true if the provided object is an attribute type having
the same numeric OID as this attribute type. |
MatchingRule |
getApproximateMatchingRule()
Returns the matching rule that should be used for approximate matching
with this attribute type.
|
String |
getDescription()
Returns the description of this schema element, or the empty string if it does not have a description.
|
MatchingRule |
getEqualityMatchingRule()
Returns the matching rule that should be used for equality matching with
this attribute type.
|
Map<String,List<String>> |
getExtraProperties()
Returns an unmodifiable map containing all of the extra properties associated with this schema element.
|
String |
getNameOrOID()
Returns the name or OID for this schema definition.
|
List<String> |
getNames()
Returns an unmodifiable list containing the user-defined names that may
be used to reference this schema definition.
|
String |
getOID()
Returns the OID for this schema definition.
|
MatchingRule |
getOrderingMatchingRule()
Returns the matching rule that should be used for ordering with this
attribute type.
|
MatchingRule |
getSubstringMatchingRule()
Returns the matching rule that should be used for substring matching with
this attribute type.
|
AttributeType |
getSuperiorType()
Returns the superior type for this attribute type.
|
Syntax |
getSyntax()
Returns the syntax for this attribute type.
|
AttributeUsage |
getUsage()
Returns the usage indicator for this attribute type.
|
int |
hashCode()
Returns the hash code for this attribute type.
|
boolean |
hasName(String name)
Indicates whether this schema definition has the specified name.
|
boolean |
hasNameOrOID(String value)
Indicates whether this schema definition has the specified name or OID.
|
boolean |
isCollective()
Indicates whether this attribute type is declared "collective".
|
boolean |
isNoUserModification()
Indicates whether this attribute type is declared "no-user-modification".
|
boolean |
isObjectClass()
Indicates whether this attribute type is the
objectClass
attribute type having the OID 2.5.4.0. |
boolean |
isObsolete()
Indicates whether this schema definition is declared "obsolete".
|
boolean |
isOperational()
Indicates whether this is an operational attribute.
|
boolean |
isPlaceHolder()
Indicates whether this attribute type is a temporary place-holder
allocated dynamically by a non-strict schema when no registered attribute
type was found.
|
boolean |
isSingleValue()
Indicates whether this attribute type is declared "single-value".
|
boolean |
isSubTypeOf(AttributeType type)
Indicates whether this attribute type is a sub-type of the
provided attribute type.
|
boolean |
isSuperTypeOf(AttributeType type)
Indicates whether this attribute type is a super-type of the
provided attribute type.
|
boolean |
matches(AttributeType type)
Implements a place-holder tolerant version of
equals(java.lang.Object) . |
String |
toString()
Returns the string representation of this schema element as defined in
RFC 2252.
|
public int compareTo(AttributeType type)
objectClass
attribute is less than all other attribute
types.
compareTo
in interface Comparable<AttributeType>
type
- The attribute type to be compared.NullPointerException
- If name
was null
.public boolean equals(Object o)
true
if the provided object is an attribute type having
the same numeric OID as this attribute type.o
- The object to be compared.true
if the provided object is an attribute type having
the same numeric OID as this attribute type.public MatchingRule getApproximateMatchingRule()
public MatchingRule getEqualityMatchingRule()
public String getNameOrOID()
public List<String> getNames()
public String getOID()
public MatchingRule getOrderingMatchingRule()
public MatchingRule getSubstringMatchingRule()
public AttributeType getSuperiorType()
null
if it does not have one.public Syntax getSyntax()
public AttributeUsage getUsage()
public int hashCode()
public boolean hasName(String name)
name
- The name for which to make the determination.true
if the specified name is assigned to this schema
definition, or false
if not.public boolean hasNameOrOID(String value)
value
- The value for which to make the determination.true
if the provided value matches the OID or one of the
names assigned to this schema definition, or false
if
not.public boolean isCollective()
true
if this attribute type is declared "collective", or
false
if not.public boolean isNoUserModification()
true
if this attribute type is declared
"no-user-modification", or false
if not.public boolean isObjectClass()
objectClass
attribute type having the OID 2.5.4.0.true
if this attribute type is the objectClass
attribute type, or false
if not.public boolean isObsolete()
true
if this schema definition is declared "obsolete", or
false
if not.public boolean isOperational()
true
if this is an operational attribute, or
false
if not.public boolean isPlaceHolder()
Place holder attribute types have an OID which is the normalized
attribute name with the string -oid
appended. In addition, they
will use the directory string syntax and case ignore matching rule.
true
if this is a temporary place-holder attribute type
allocated dynamically by a non-strict schema when no registered
attribute type was found.Schema.getAttributeType(String)
public boolean isSingleValue()
true
if this attribute type is declared "single-value",
or false
if not.public boolean isSubTypeOf(AttributeType type)
type
- The attribute type for which to make the determination.true
if this attribute type is a sub-type of the provided
attribute type, or false
if not.NullPointerException
- If type
was null
.public boolean isSuperTypeOf(AttributeType type)
type
- The attribute type for which to make the determination.true
if this attribute type is a super-type of the
provided attribute type, or false
if not.NullPointerException
- If type
was null
.public boolean matches(AttributeType type)
equals(java.lang.Object)
. This
method returns true
in the following cases:
equals(java.lang.Object)
type
- The attribute type for which to make the determination.true
if the provided attribute type matches this
attribute type.public final String getDescription()
SchemaElement
getDescription
in interface SchemaElement
public final Map<String,List<String>> getExtraProperties()
SchemaElement
getExtraProperties
in interface SchemaElement
Copyright 2010-2017 ForgeRock AS.