public static final class AttributeType.Builder extends Object
Modifier and Type | Method and Description |
---|---|
SchemaBuilder |
addToSchema()
Adds this attribute type to the schema, throwing a
ConflictingSchemaElementException if there is an existing
attribute type with the same numeric OID. |
SchemaBuilder |
addToSchemaOverwrite()
Adds this attribute type to the schema overwriting any existing
attribute type with the same numeric OID.
|
AttributeType.Builder |
approximateMatchingRule(String approximateMatchingRuleOid)
Sets the matching rule that should be used for approximate matching
with this attribute type.
|
AttributeType.Builder |
collective(boolean isCollective)
Specifies whether this attribute type is "collective".
|
AttributeType.Builder |
description(String description)
Sets the description.
|
AttributeType.Builder |
equalityMatchingRule(String equalityMatchingRuleOid)
Sets the matching rule that should be used for equality matching with
this attribute type.
|
AttributeType.Builder |
extraProperties(Map<String,List<String>> extraProperties)
Adds the provided collection of extended properties.
|
T |
extraProperties(String extensionName,
List<String> extensionValues)
Adds the provided extended property.
|
AttributeType.Builder |
extraProperties(String extensionName,
String... extensionValues)
Adds the provided extended property.
|
AttributeType.Builder |
names(Collection<String> names)
Adds the provided user friendly names.
|
AttributeType.Builder |
names(String... names)
Adds the provided user friendly names.
|
AttributeType.Builder |
noUserModification(boolean isNoUserModification)
Specifies whether this attribute type is "no-user-modification".
|
AttributeType.Builder |
obsolete(boolean isObsolete)
Specifies whether this schema element is obsolete.
|
AttributeType.Builder |
oid(String oid)
Sets the numeric OID which uniquely identifies this attribute type.
|
AttributeType.Builder |
orderingMatchingRule(String orderingMatchingRuleOid)
Sets the matching rule that should be used for ordering with this
attribute type.
|
AttributeType.Builder |
removeAllExtraProperties()
Removes all extra properties.
|
AttributeType.Builder |
removeAllNames()
Removes all user defined names.
|
AttributeType.Builder |
removeExtraProperty(String extensionName,
String... extensionValues)
Removes the specified extended property.
|
AttributeType.Builder |
removeName(String name)
Removes the provided user defined name.
|
AttributeType.Builder |
singleValue(boolean isSingleValue)
Specifies whether this attribute type is declared "single-value".
|
AttributeType.Builder |
substringMatchingRule(String substringMatchingRuleOid)
Sets the matching rule that should be used for substring matching
with this attribute type.
|
AttributeType.Builder |
superiorType(String superiorTypeOid)
Sets the superior type for this attribute type.
|
AttributeType.Builder |
syntax(String syntaxOid)
Sets the syntax for this attribute type.
|
AttributeType.Builder |
usage(AttributeUsage attributeUsage)
Sets the usage indicator for this attribute type.
|
public SchemaBuilder addToSchema()
ConflictingSchemaElementException
if there is an existing
attribute type with the same numeric OID.ConflictingSchemaElementException
- If there is an existing attribute type with the same
numeric OID.public SchemaBuilder addToSchemaOverwrite()
public AttributeType.Builder approximateMatchingRule(String approximateMatchingRuleOid)
approximateMatchingRuleOid
- The matching rule OID.public AttributeType.Builder collective(boolean isCollective)
isCollective
- true
if this attribute type is "collective".public AttributeType.Builder description(String description)
description
- The description, which may be null
in which case
the empty string will be used.public AttributeType.Builder equalityMatchingRule(String equalityMatchingRuleOid)
equalityMatchingRuleOid
- The matching rule OID.public AttributeType.Builder extraProperties(Map<String,List<String>> extraProperties)
extraProperties
- The collection of extended properties.public AttributeType.Builder extraProperties(String extensionName, String... extensionValues)
extensionName
- The name of the extended property.extensionValues
- The optional list of values for the extended property.public AttributeType.Builder names(Collection<String> names)
names
- The user friendly names.public AttributeType.Builder names(String... names)
names
- The user friendly names.public AttributeType.Builder noUserModification(boolean isNoUserModification)
isNoUserModification
- true
if this attribute type is
"no-user-modification"public AttributeType.Builder obsolete(boolean isObsolete)
isObsolete
- true
if this schema element is obsolete (default
is false
).public AttributeType.Builder oid(String oid)
oid
- The numeric OID.public AttributeType.Builder orderingMatchingRule(String orderingMatchingRuleOid)
orderingMatchingRuleOid
- The matching rule OID.public AttributeType.Builder removeAllExtraProperties()
public AttributeType.Builder removeAllNames()
public AttributeType.Builder removeExtraProperty(String extensionName, String... extensionValues)
extensionName
- The name of the extended property.extensionValues
- The optional list of values for the extended property,
which may be empty indicating that the entire property
should be removed.public AttributeType.Builder removeName(String name)
name
- The user defined name to be removed.public AttributeType.Builder singleValue(boolean isSingleValue)
isSingleValue
- true
if this attribute type is declared
"single-value".public AttributeType.Builder substringMatchingRule(String substringMatchingRuleOid)
substringMatchingRuleOid
- The matching rule OID.public AttributeType.Builder superiorType(String superiorTypeOid)
superiorTypeOid
- The superior type OID.public AttributeType.Builder syntax(String syntaxOid)
syntaxOid
- The syntax OID.public AttributeType.Builder usage(AttributeUsage attributeUsage)
attributeUsage
- The attribute usage.Copyright © 2010-2018, ForgeRock All Rights Reserved.