@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class AttributeType extends CommonSchemaElements implements Comparable<AttributeType>
Any methods which accesses the set of names associated with this
attribute type, will retrieve the primary name as the first name,
regardless of whether or not it was contained in the original set
of names
passed to the constructor.
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.
Constructor and Description |
---|
AttributeType(String definition,
String primaryName,
Collection<String> typeNames,
String oid,
String description,
AttributeType superiorType,
org.forgerock.opendj.ldap.schema.Syntax syntax,
org.forgerock.opendj.ldap.schema.AttributeUsage attributeUsage,
boolean isCollective,
boolean isNoUserModification,
boolean isObsolete,
boolean isSingleValue)
Creates a new attribute type with the provided information.
|
AttributeType(String definition,
String primaryName,
Collection<String> typeNames,
String oid,
String description,
AttributeType superiorType,
org.forgerock.opendj.ldap.schema.Syntax syntax,
org.forgerock.opendj.ldap.schema.MatchingRule approximateMatchingRule,
org.forgerock.opendj.ldap.schema.MatchingRule equalityMatchingRule,
org.forgerock.opendj.ldap.schema.MatchingRule orderingMatchingRule,
org.forgerock.opendj.ldap.schema.MatchingRule substringMatchingRule,
org.forgerock.opendj.ldap.schema.AttributeUsage attributeUsage,
boolean isCollective,
boolean isNoUserModification,
boolean isObsolete,
boolean isSingleValue,
Map<String,List<String>> extraProperties)
Creates a new attribute type with the provided information.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(AttributeType o) |
org.forgerock.opendj.ldap.schema.MatchingRule |
getApproximateMatchingRule()
Retrieves the matching rule that should be used for approximate
matching with this attribute type.
|
org.forgerock.opendj.ldap.schema.MatchingRule |
getEqualityMatchingRule()
Retrieves the matching rule that should be used for equality
matching with this attribute type.
|
org.forgerock.opendj.ldap.schema.MatchingRule |
getOrderingMatchingRule()
Retrieves the matching rule that should be used for ordering with
this attribute type.
|
org.forgerock.opendj.ldap.schema.MatchingRule |
getSubstringMatchingRule()
Retrieves the matching rule that should be used for substring
matching with this attribute type.
|
AttributeType |
getSuperiorType()
Retrieves the superior type for this attribute type.
|
org.forgerock.opendj.ldap.schema.Syntax |
getSyntax()
Retrieves the syntax for this attribute type.
|
org.forgerock.opendj.ldap.schema.AttributeUsage |
getUsage()
Retrieves the usage indicator for this attribute type.
|
boolean |
isCollective()
Indicates whether this attribute type is declared "collective".
|
boolean |
isDirty()
Returns
true if this attribute type has been removed or replaced in
the schema. |
boolean |
isNoUserModification()
Indicates whether this attribute type is declared
"no-user-modification".
|
boolean |
isObjectClass()
Indicates whether this attribute type represents the
"objectclass" attribute.
|
boolean |
isOperational()
Indicates whether this is an operational attribute.
|
boolean |
isSingleValue()
Indicates whether this attribute type is declared "single-value".
|
AttributeType |
setDirty()
Marks this attribute type as dirty, indicating that it has been removed or
replaced in the schema.
|
String |
toString() |
checkSafeProperties, equals, getDefinitionWithFileName, getDescription, getExtraProperties, getNameOrOID, getNormalizedNames, getNormalizedPrimaryName, getNormalizedPrimaryNameOrOID, getOID, getPrimaryName, getSchemaFile, getSingleValueProperty, getUserDefinedNames, hashCode, hasName, hasNameOrOID, isObsolete, setExtraProperty, setExtraProperty, setSchemaFile
public AttributeType(String definition, String primaryName, Collection<String> typeNames, String oid, String description, AttributeType superiorType, org.forgerock.opendj.ldap.schema.Syntax syntax, org.forgerock.opendj.ldap.schema.AttributeUsage attributeUsage, boolean isCollective, boolean isNoUserModification, boolean isObsolete, boolean isSingleValue)
If no primaryName
is specified, but a set of
names
is specified, then the first name retrieved
from the set of names
will be used as the primary
name.
definition
- The definition string used to create this attribute
type. It must not be null
.primaryName
- The primary name for this attribute type, or
null
if there is no primary name.typeNames
- The full set of names for this attribute type, or
null
if there are no names.oid
- The OID for this attribute type. It must not be
null
.description
- The description for the attribute type, or
null
if there is no description.superiorType
- The reference to the superior type for this attribute
type, or null
if there is no superior
type.syntax
- The syntax for this attribute type, or null
if there is no syntax.attributeUsage
- The attribute usage for this attribute type, or
null
to default to user applications.isCollective
- Indicates whether this attribute type is declared
"collective".isNoUserModification
- Indicates whether this attribute type is declared
"no-user-modification".isObsolete
- Indicates whether this attribute type is declared
"obsolete".isSingleValue
- Indicates whether this attribute type is declared
"single-value".public AttributeType(String definition, String primaryName, Collection<String> typeNames, String oid, String description, AttributeType superiorType, org.forgerock.opendj.ldap.schema.Syntax syntax, org.forgerock.opendj.ldap.schema.MatchingRule approximateMatchingRule, org.forgerock.opendj.ldap.schema.MatchingRule equalityMatchingRule, org.forgerock.opendj.ldap.schema.MatchingRule orderingMatchingRule, org.forgerock.opendj.ldap.schema.MatchingRule substringMatchingRule, org.forgerock.opendj.ldap.schema.AttributeUsage attributeUsage, boolean isCollective, boolean isNoUserModification, boolean isObsolete, boolean isSingleValue, Map<String,List<String>> extraProperties)
If no primaryName
is specified, but a set of
names
is specified, then the first name retrieved
from the set of names
will be used as the primary
name.
definition
- The definition string used to create this attribute
type. It must not be null
.primaryName
- The primary name for this attribute type, or
null
if there is no primary name.typeNames
- The full set of names for this attribute type, or
null
if there are no names.oid
- The OID for this attribute type. It must not be
null
.description
- The description for the attribute type, or
null
if there is no description.superiorType
- The reference to the superior type for this attribute
type, or null
if there is no superior
type.syntax
- The syntax for this attribute type, or null
if there is no syntax.approximateMatchingRule
- The approximate matching rule for this attribute type,
or null
if there is no rule.equalityMatchingRule
- The equality matching rule for this attribute type, or
null
if there is no rule.orderingMatchingRule
- The ordering matching rule for this attribute type, or
null
if there is no rule.substringMatchingRule
- The substring matching rule for this attribute type, or
null
if there is no rule.attributeUsage
- The attribute usage for this attribute type, or
null
to default to user applications.isCollective
- Indicates whether this attribute type is declared
"collective".isNoUserModification
- Indicates whether this attribute type is declared
"no-user-modification".isObsolete
- Indicates whether this attribute type is declared
"obsolete".isSingleValue
- Indicates whether this attribute type is declared
"single-value".extraProperties
- A set of extra properties for this attribute type, or
null
if there are no extra properties.public AttributeType getSuperiorType()
null
if it does not have one.public org.forgerock.opendj.ldap.schema.Syntax getSyntax()
public org.forgerock.opendj.ldap.schema.MatchingRule getApproximateMatchingRule()
public org.forgerock.opendj.ldap.schema.MatchingRule getEqualityMatchingRule()
public org.forgerock.opendj.ldap.schema.MatchingRule getOrderingMatchingRule()
public org.forgerock.opendj.ldap.schema.MatchingRule getSubstringMatchingRule()
public org.forgerock.opendj.ldap.schema.AttributeUsage getUsage()
public boolean isOperational()
true
if this is an operational attribute,
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 isSingleValue()
true
if this attribute type is declared
"single-value", or false
if not.public boolean isObjectClass()
true
if this attribute type is the
objectclass type, or false
if not.public int compareTo(AttributeType o)
compareTo
in interface Comparable<AttributeType>
public AttributeType setDirty()
public boolean isDirty()
true
if this attribute type has been removed or replaced in
the schema.true
if this attribute type has been removed or replaced in
the schema.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.