Uses of Class
org.forgerock.opendj.ldap.AttributeDescription

Packages that use AttributeDescription

Package	Description
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.controls	Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.requests	Classes and interfaces for core LDAP requests.
org.forgerock.opendj.ldap.responses	Classes and interfaces for core LDAP responses.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.

Uses of AttributeDescription in org.forgerock.opendj.ldap

Methods in org.forgerock.opendj.ldap that return AttributeDescription

Modifier and Type	Method	Description
AttributeDescription	AttributeParser.asAttributeDescription()	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or null if the attribute does not contain any values.
AttributeDescription	AttributeParser.asAttributeDescription(String defaultValue)	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
AttributeDescription	AttributeParser.asAttributeDescription(AttributeDescription defaultValue)	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
static AttributeDescription	AttributeDescription.create(String attributeName, AttributeType attributeType)	Deprecated. This method may be removed at any time
static AttributeDescription	AttributeDescription.create(String attributeName, AttributeType attributeType, String option)	Deprecated. This method may be removed at any time
static AttributeDescription	AttributeDescription.create(String attributeName, AttributeType attributeType, String... options)	Deprecated. This method may be removed at any time
static AttributeDescription	AttributeDescription.create(String attributeName, AttributeType attributeType, Collection<String> options)	Deprecated. This method may be removed at any time
static AttributeDescription	AttributeDescription.create(AttributeType attributeType)	Creates an attribute description having the provided attribute type and no options.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType, String option)	Creates an attribute description having the provided attribute type and single option.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType, String... options)	Creates an attribute description having the provided attribute type and options.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType, Collection<String> options)	Creates an attribute description having the provided attribute type and options.
abstract AttributeDescription	AbstractAttribute.getAttributeDescription()
AttributeDescription	Attribute.getAttributeDescription()	Returns the attribute description of this attribute, which includes its attribute type and any options.
AttributeDescription	LinkedAttribute.getAttributeDescription()
static AttributeDescription	AttributeDescription.objectClass()	Returns an attribute description representing the object class attribute type with no options.
static AttributeDescription	AttributeDescription.valueOf(String attributeDescription)	Parses the provided LDAP string representation of an attribute description using the default schema.
static AttributeDescription	AttributeDescription.valueOf(String attributeDescription, Schema schema)	Parses the provided LDAP string representation of an attribute description using the provided schema.
AttributeDescription	AttributeDescription.withOption(String option)	Returns an attribute description having the same attribute type and options as this attribute description as well as the provided option.
AttributeDescription	AttributeDescription.withoutAnyOptions()	Returns an attribute description having the same attribute type as this attribute description except that all options has been removed.
AttributeDescription	AttributeDescription.withoutOption(String option)	Returns an attribute description having the same attribute type and options as this attribute description except for the provided option.

Methods in org.forgerock.opendj.ldap that return types with arguments of type AttributeDescription

Modifier and Type	Method	Description
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription()	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or an empty set if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(String... defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(AttributeDescription... defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
static org.forgerock.util.Function<ByteString,AttributeDescription,org.forgerock.i18n.LocalizedIllegalArgumentException>	Functions.byteStringToAttributeDescription()	Returns a function which parses AttributeDescriptions using the default schema.
static org.forgerock.util.Function<ByteString,AttributeDescription,org.forgerock.i18n.LocalizedIllegalArgumentException>	Functions.byteStringToAttributeDescription(Schema schema)	Returns a function which parses AttributeDescriptions using the provided schema.
static org.forgerock.util.Function<String,AttributeDescription,org.forgerock.i18n.LocalizedIllegalArgumentException>	Functions.stringToAttributeDescription()	Returns a function which parses AttributeDescriptions using the default schema.
static org.forgerock.util.Function<String,AttributeDescription,org.forgerock.i18n.LocalizedIllegalArgumentException>	Functions.stringToAttributeDescription(Schema schema)	Returns a function which parses AttributeDescriptions using the provided schema.

Methods in org.forgerock.opendj.ldap with parameters of type AttributeDescription

Modifier and Type	Method	Description
AttributeDescription	AttributeParser.asAttributeDescription(AttributeDescription defaultValue)	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(AttributeDescription... defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
int	AttributeDescription.compareTo(AttributeDescription other)	Compares this attribute description to the provided attribute description.
static Attribute	Attributes.emptyAttribute(AttributeDescription attributeDescription)	Returns a read-only empty attribute having the specified attribute description.
Iterable<Attribute>	AbstractEntry.getAllAttributes(AttributeDescription attributeDescription)
Iterable<Attribute>	Entry.getAllAttributes(AttributeDescription attributeDescription)	Returns an Iterable containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.
Attribute	AbstractEntry.getAttribute(AttributeDescription attributeDescription)
Attribute	Entry.getAttribute(AttributeDescription attributeDescription)	Returns the named attribute contained in this entry, or null if it is not included with this entry.
AttributeFilter	AttributeFilter.includeAttribute(AttributeDescription attributeDescription)	Specifies that the named attribute should be included in filtered entries.
boolean	AttributeDescription.isSubTypeOf(AttributeDescription other)	Indicates whether this attribute description is a sub-type of the provided attribute description as defined in RFC 4512 section 2.5.
boolean	AttributeDescription.isSuperTypeOf(AttributeDescription other)	Indicates whether this attribute description is a super-type of the provided attribute description as defined in RFC 4512 section 2.5.
boolean	AttributeDescription.matches(AttributeDescription other)	Indicates whether the provided attribute description matches this attribute description.
Attribute	AttributeFactory.newAttribute(AttributeDescription attributeDescription)	Creates an attribute using the provided attribute description and no values.
AttributeParser	AbstractEntry.parseAttribute(AttributeDescription attributeDescription)
AttributeParser	Entry.parseAttribute(AttributeDescription attributeDescription)	Returns a parser for the named attribute contained in this entry.
boolean	AbstractEntry.removeAttribute(AttributeDescription attributeDescription)
boolean	Entry.removeAttribute(AttributeDescription attributeDescription)	Removes the named attribute from this entry if it is present (optional operation).
static Attribute	Attributes.renameAttribute(Attribute attribute, AttributeDescription attributeDescription)	Returns a view of attribute having a different attribute description.
static Attribute	Attributes.singletonAttribute(AttributeDescription attributeDescription, Object value)	Returns a read-only single-valued attribute having the specified attribute description and value.

Method parameters in org.forgerock.opendj.ldap with type arguments of type AttributeDescription

Modifier and Type	Method	Description
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.

Constructors in org.forgerock.opendj.ldap with parameters of type AttributeDescription

Modifier	Constructor	Description
	LinkedAttribute(AttributeDescription attributeDescription)	Creates a new attribute having the specified attribute description and no attribute values.
	LinkedAttribute(AttributeDescription attributeDescription, Object value)	Creates a new attribute having the specified attribute description and single attribute value.
	LinkedAttribute(AttributeDescription attributeDescription, Object... values)	Creates a new attribute having the specified attribute description and attribute values.
	LinkedAttribute(AttributeDescription attributeDescription, Collection<?> values)	Creates a new attribute having the specified attribute description and attribute values.
	SortKey(AttributeDescription attributeDescription, boolean isReverseOrder, MatchingRule orderingMatchingRule)	Creates a new sort key using the provided attribute description.

Uses of AttributeDescription in org.forgerock.opendj.ldap.controls

Methods in org.forgerock.opendj.ldap.controls that return AttributeDescription

Modifier and Type	Method	Description
AttributeDescription	ServerSideSortResponseControl.getAttributeDescription()	Returns the first attribute description specified in the list of sort keys that was in error, or null if the attribute description was not included with this control.

Methods in org.forgerock.opendj.ldap.controls with parameters of type AttributeDescription

Modifier and Type	Method	Description
static ServerSideSortResponseControl	ServerSideSortResponseControl.newControl(ResultCode result, AttributeDescription attributeDescription)	Creates a new server-side response control with the provided sort result and attribute description.

Uses of AttributeDescription in org.forgerock.opendj.ldap.requests

Methods in org.forgerock.opendj.ldap.requests that return AttributeDescription

Modifier and Type	Method	Description
AttributeDescription	CompareRequest.getAttributeDescription()	Returns the name of the attribute to be compared.

Methods in org.forgerock.opendj.ldap.requests with parameters of type AttributeDescription

Modifier and Type	Method	Description
Iterable<Attribute>	AddRequest.getAllAttributes(AttributeDescription attributeDescription)
Attribute	AddRequest.getAttribute(AttributeDescription attributeDescription)
static CompareRequest	Requests.newCompareRequest(DN name, AttributeDescription attributeDescription, Object assertionValue)	Creates a new compare request using the provided distinguished name, attribute name, and assertion value.
boolean	AddRequest.removeAttribute(AttributeDescription attributeDescription)
CompareRequest	CompareRequest.setAttributeDescription(AttributeDescription attributeDescription)	Sets the name of the attribute to be compared.

Uses of AttributeDescription in org.forgerock.opendj.ldap.responses

Methods in org.forgerock.opendj.ldap.responses with parameters of type AttributeDescription

Modifier and Type	Method	Description
Iterable<Attribute>	SearchResultEntry.getAllAttributes(AttributeDescription attributeDescription)
Attribute	SearchResultEntry.getAttribute(AttributeDescription attributeDescription)
boolean	SearchResultEntry.removeAttribute(AttributeDescription attributeDescription)

Uses of AttributeDescription in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif with parameters of type AttributeDescription

Modifier and Type	Method	Description
LDIFChangeRecordReader	LDIFChangeRecordReader.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any change records that are read from LDIF.
LDIFChangeRecordWriter	LDIFChangeRecordWriter.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any change records that are written to LDIF.
LDIFEntryReader	LDIFEntryReader.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any entries that are read from LDIF.
LDIFEntryWriter	LDIFEntryWriter.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any entries that are written to LDIF.
LDIFChangeRecordReader	LDIFChangeRecordReader.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any change records that are read from LDIF.
LDIFChangeRecordWriter	LDIFChangeRecordWriter.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any change records that are written to LDIF.
LDIFEntryReader	LDIFEntryReader.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any entries that are read from LDIF.
LDIFEntryWriter	LDIFEntryWriter.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any entries that are written to LDIF.