public final class AttributeParser extends Object
Entry.parseAttribute(org.forgerock.opendj.ldap.AttributeDescription)
or from an attribute using
Attribute.parse()
.
Methods throw an IllegalArgumentException
when a value cannot be
parsed (e.g. because its syntax is invalid). Methods which return a
Set
always return a modifiable non-null
result, even if the
attribute is null
or empty.
Examples:
Entry entry = ...; Calendar timestamp = entry.parseAttribute("createTimestamp").asCalendar(); boolean isEnabled = entry.parseAttribute("enabled").asBoolean(false); Entry group = ...; Schema schema = ...; Set<DN> members = group.parseAttribute("member").usingSchema(schema).asSetOfDN();
Modifier and Type | Method and Description |
---|---|
<T,E extends Exception> |
as(Function<ByteString,? extends T,E> f)
Returns the first value decoded as a
T using the provided
Function , or null if the attribute does not contain any
values. |
<T,E extends Exception> |
as(Function<ByteString,? extends T,E> f,
T defaultValue)
Returns the first value decoded as a
T using the provided
Function , or defaultValue if the attribute does not
contain any values. |
AttributeDescription |
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 |
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. |
AttributeDescription |
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. |
Boolean |
asBoolean()
Returns the first value decoded as a boolean, or
null if the
attribute does not contain any values. |
boolean |
asBoolean(boolean defaultValue)
Returns the first value decoded as an
Boolean , or
defaultValue if the attribute does not contain any values. |
ByteString |
asByteString()
Returns the first value, or
null if the attribute does not
contain any values. |
ByteString |
asByteString(ByteString defaultValue)
Returns the first value, or
defaultValue if the attribute does
not contain any values. |
X509Certificate |
asCertificate()
Returns the first value decoded as a
X509Certificate , or null if the attribute does not
contain any values. |
X509Certificate |
asCertificate(X509Certificate defaultValue)
Returns the first value decoded as a
X509Certificate , or defaultValue if the attribute
does not contain any values. |
Dn |
asDn()
Returns the first value decoded as a
DN using the schema
associated with this parser, or null if the attribute does not
contain any values. |
Dn |
asDn(Dn defaultValue)
Returns the first value decoded as a
DN using the schema
associated with this parser, or defaultValue if the attribute
does not contain any values. |
Dn |
asDn(String defaultValue)
Returns the first value decoded as a
DN using the schema
associated with this parser, or defaultValue if the attribute
does not contain any values. |
GeneralizedTime |
asGeneralizedTime()
Returns the first value decoded as a
GeneralizedTime using the
generalized time syntax, or null if the attribute does not
contain any values. |
GeneralizedTime |
asGeneralizedTime(GeneralizedTime defaultValue)
Returns the first value decoded as an
GeneralizedTime using the
generalized time syntax, or defaultValue if the attribute does
not contain any values. |
Integer |
asInteger()
Returns the first value decoded as an
Integer , or null if
the attribute does not contain any values. |
int |
asInteger(int defaultValue)
Returns the first value decoded as an
Integer , or
defaultValue if the attribute does not contain any values. |
Long |
asLong()
Returns the first value decoded as a
Long , or null if the
attribute does not contain any values. |
long |
asLong(long defaultValue)
Returns the first value decoded as a
Long , or
defaultValue if the attribute does not contain any values. |
<T,E extends Exception> |
asSetOf(Function<ByteString,? extends T,E> f,
Collection<? extends T> defaultValues)
Returns the values decoded as a set of
T s using the provided
Function , or defaultValues if the attribute does not
contain any values. |
<T,E extends Exception> |
asSetOf(Function<ByteString,? extends T,E> f,
T... defaultValues)
Returns the values decoded as a set of
T s using the provided
Function , or defaultValues if the attribute does not
contain any values. |
Set<AttributeDescription> |
asSetOfAttributeDescription()
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or an empty set if the
attribute does not contain any values. |
Set<AttributeDescription> |
asSetOfAttributeDescription(AttributeDescription... defaultValues)
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or defaultValues if
the attribute does not contain any values. |
Set<AttributeDescription> |
asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or defaultValues if
the attribute does not contain any values. |
Set<AttributeDescription> |
asSetOfAttributeDescription(String... defaultValues)
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or defaultValues if
the attribute does not contain any values. |
Set<Boolean> |
asSetOfBoolean(Boolean... defaultValues)
Returns the values decoded as a set of
Boolean s, or
defaultValues if the attribute does not contain any values. |
Set<Boolean> |
asSetOfBoolean(Collection<Boolean> defaultValues)
Returns the values decoded as a set of
Boolean s, or
defaultValues if the attribute does not contain any values. |
Set<ByteString> |
asSetOfByteString(ByteString... defaultValues)
Returns the values contained in the attribute, or
defaultValues
if the attribute does not contain any values. |
Set<ByteString> |
asSetOfByteString(Collection<ByteString> defaultValues)
Returns the values contained in the attribute, or
defaultValues
if the attribute does not contain any values. |
Set<X509Certificate> |
asSetOfCertificate()
Returns the values decoded as a set of
X509Certificate s, or an empty set if the attribute does not
contain any values. |
Set<Dn> |
asSetOfDn()
Returns the values decoded as a set of
DN s using the schema
associated with this parser, or an empty set if the attribute does not
contain any values. |
Set<Dn> |
asSetOfDn(Collection<Dn> defaultValues)
Returns the values decoded as a set of
DN s using the schema
associated with this parser, or defaultValues if the attribute
does not contain any values. |
Set<Dn> |
asSetOfDn(Dn... defaultValues)
Returns the values decoded as a set of
DN s using the schema
associated with this parser, or defaultValues if the attribute
does not contain any values. |
Set<Dn> |
asSetOfDn(String... defaultValues)
Returns the values decoded as a set of
DN s using the schema
associated with this parser, or defaultValues if the attribute
does not contain any values. |
Set<GeneralizedTime> |
asSetOfGeneralizedTime(Collection<GeneralizedTime> defaultValues)
Returns the values decoded as a set of
GeneralizedTime s using the
generalized time syntax, or defaultValues if the attribute does
not contain any values. |
Set<GeneralizedTime> |
asSetOfGeneralizedTime(GeneralizedTime... defaultValues)
Returns the values decoded as a set of
GeneralizedTime s using the
generalized time syntax, or defaultValues if the attribute does
not contain any values. |
Set<Integer> |
asSetOfInteger(Collection<Integer> defaultValues)
Returns the values decoded as a set of
Integer s, or
defaultValues if the attribute does not contain any values. |
Set<Integer> |
asSetOfInteger(Integer... defaultValues)
Returns the values decoded as a set of
Integer s, or
defaultValues if the attribute does not contain any values. |
Set<Long> |
asSetOfLong(Collection<Long> defaultValues)
Returns the values decoded as a set of
Long s, or
defaultValues if the attribute does not contain any values. |
Set<Long> |
asSetOfLong(Long... defaultValues)
Returns the values decoded as a set of
Long s, or
defaultValues if the attribute does not contain any values. |
Set<String> |
asSetOfString(Collection<String> defaultValues)
Returns the values decoded as a set of
String s, or
defaultValues if the attribute does not contain any values. |
Set<String> |
asSetOfString(String... defaultValues)
Returns the values decoded as a set of
String s, or
defaultValues if the attribute does not contain any values. |
String |
asString()
Returns the first value decoded as a
String , or null if
the attribute does not contain any values. |
String |
asString(String defaultValue)
Returns the first value decoded as a
String , or
defaultValue if the attribute does not contain any values. |
static AttributeParser |
parseAttribute(Attribute attribute)
Returns an attribute parser for the provided attribute.
|
AttributeParser |
requireValue()
Throws a
LocalizedIllegalArgumentException if the attribute referenced by this parser is null or
empty. |
AttributeParser |
usingSchema(Schema schema)
Sets the
Schema which will be used when parsing schema sensitive
values such as DNs and attribute descriptions. |
public static AttributeParser parseAttribute(Attribute attribute)
null
attributes are permitted and will be treated as if an empty attribute was
provided.attribute
- The attribute to be parsed, which may be null
.public <T,E extends Exception> T as(Function<ByteString,? extends T,E> f) throws E extends Exception
T
using the provided
Function
, or null
if the attribute does not contain any
values.T
- The type of the value to be decoded.E
- The type of exception thrown by the function.f
- The function which should be used to decode the value.T
.E
- If an error occurred when parsing the attribute.E extends Exception
public <T,E extends Exception> T as(Function<ByteString,? extends T,E> f, T defaultValue) throws E extends Exception
T
using the provided
Function
, or defaultValue
if the attribute does not
contain any values.T
- The type of the value to be decoded.E
- The type of exception thrown by the function.f
- The function which should be used to decode the value.defaultValue
- The default value to return if the attribute is empty.T
.E
- If an error occurred when parsing the attribute.E extends Exception
public AttributeDescription asAttributeDescription()
AttributeDescription
using
the schema associated with this parser, or null
if the attribute
does not contain any values.AttributeDescription
.public AttributeDescription asAttributeDescription(AttributeDescription defaultValue)
AttributeDescription
using
the schema associated with this parser, or defaultValue
if the
attribute does not contain any values.defaultValue
- The default value to return if the attribute is empty.AttributeDescription
.public AttributeDescription asAttributeDescription(String defaultValue)
AttributeDescription
using
the schema associated with this parser, or defaultValue
if the
attribute does not contain any values.defaultValue
- The default value to return if the attribute is empty.AttributeDescription
.public Boolean asBoolean()
null
if the
attribute does not contain any values.public boolean asBoolean(boolean defaultValue)
Boolean
, or
defaultValue
if the attribute does not contain any values.defaultValue
- The default value to return if the attribute is empty.Boolean
.public ByteString asByteString()
null
if the attribute does not
contain any values.public ByteString asByteString(ByteString defaultValue)
defaultValue
if the attribute does
not contain any values.defaultValue
- The default value to return if the attribute is empty.public X509Certificate asCertificate()
X509Certificate
, or null
if the attribute does not
contain any values.X509Certificate
.public X509Certificate asCertificate(X509Certificate defaultValue)
X509Certificate
, or defaultValue
if the attribute
does not contain any values.defaultValue
- The default value to return if the attribute is empty.X509Certificate
.public Dn asDn()
DN
using the schema
associated with this parser, or null
if the attribute does not
contain any values.DN
.public Dn asDn(Dn defaultValue)
DN
using the schema
associated with this parser, or defaultValue
if the attribute
does not contain any values.defaultValue
- The default value to return if the attribute is empty.DN
.public Dn asDn(String defaultValue)
DN
using the schema
associated with this parser, or defaultValue
if the attribute
does not contain any values.defaultValue
- The default value to return if the attribute is empty.DN
.public GeneralizedTime asGeneralizedTime()
GeneralizedTime
using the
generalized time syntax, or null
if the attribute does not
contain any values.GeneralizedTime
.public GeneralizedTime asGeneralizedTime(GeneralizedTime defaultValue)
GeneralizedTime
using the
generalized time syntax, or defaultValue
if the attribute does
not contain any values.defaultValue
- The default value to return if the attribute is empty.GeneralizedTime
.public Integer asInteger()
Integer
, or null
if
the attribute does not contain any values.Integer
.public int asInteger(int defaultValue)
Integer
, or
defaultValue
if the attribute does not contain any values.defaultValue
- The default value to return if the attribute is empty.Integer
.public Long asLong()
Long
, or null
if the
attribute does not contain any values.Long
.public long asLong(long defaultValue)
Long
, or
defaultValue
if the attribute does not contain any values.defaultValue
- The default value to return if the attribute is empty.Long
.public <T,E extends Exception> Set<T> asSetOf(Function<ByteString,? extends T,E> f, Collection<? extends T> defaultValues) throws E extends Exception
T
s using the provided
Function
, or defaultValues
if the attribute does not
contain any values.T
- The type of the values to be decoded.E
- The type of exception thrown by the function.f
- The function which should be used to decode values.defaultValues
- The default values to return if the attribute is empty.T
s.E
- If an error occurred when parsing the attribute.E extends Exception
@SafeVarargs public final <T,E extends Exception> Set<T> asSetOf(Function<ByteString,? extends T,E> f, T... defaultValues) throws E extends Exception
T
s using the provided
Function
, or defaultValues
if the attribute does not
contain any values.T
- The type of the values to be decoded.E
- The type of exception thrown by the function.f
- The function which should be used to decode values.defaultValues
- The default values to return if the attribute is empty.T
s.E
- If an error occurred when parsing the attribute.E extends Exception
public Set<AttributeDescription> asSetOfAttributeDescription()
AttributeDescription
s
using the schema associated with this parser, or an empty set if the
attribute does not contain any values.AttributeDescription
s.public Set<AttributeDescription> asSetOfAttributeDescription(AttributeDescription... defaultValues)
AttributeDescription
s
using the schema associated with this parser, or defaultValues
if
the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.AttributeDescription
s.public Set<AttributeDescription> asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)
AttributeDescription
s
using the schema associated with this parser, or defaultValues
if
the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.AttributeDescription
s.public Set<AttributeDescription> asSetOfAttributeDescription(String... defaultValues)
AttributeDescription
s
using the schema associated with this parser, or defaultValues
if
the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.AttributeDescription
s.public Set<Boolean> asSetOfBoolean(Boolean... defaultValues)
Boolean
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.Boolean
s.public Set<Boolean> asSetOfBoolean(Collection<Boolean> defaultValues)
Boolean
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.Boolean
s.public Set<ByteString> asSetOfByteString(ByteString... defaultValues)
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.public Set<ByteString> asSetOfByteString(Collection<ByteString> defaultValues)
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.public Set<X509Certificate> asSetOfCertificate()
X509Certificate
s, or an empty set if the attribute does not
contain any values.X509Certificate
s.public Set<Dn> asSetOfDn()
DN
s using the schema
associated with this parser, or an empty set if the attribute does not
contain any values.DN
s.public Set<Dn> asSetOfDn(Collection<Dn> defaultValues)
DN
s using the schema
associated with this parser, or defaultValues
if the attribute
does not contain any values.defaultValues
- The default values to return if the attribute is empty.DN
s.public Set<Dn> asSetOfDn(Dn... defaultValues)
DN
s using the schema
associated with this parser, or defaultValues
if the attribute
does not contain any values.defaultValues
- The default values to return if the attribute is empty.DN
s.public Set<Dn> asSetOfDn(String... defaultValues)
DN
s using the schema
associated with this parser, or defaultValues
if the attribute
does not contain any values.defaultValues
- The default values to return if the attribute is empty.DN
s.public Set<GeneralizedTime> asSetOfGeneralizedTime(Collection<GeneralizedTime> defaultValues)
GeneralizedTime
s using the
generalized time syntax, or defaultValues
if the attribute does
not contain any values.defaultValues
- The default values to return if the attribute is empty.GeneralizedTime
s.public Set<GeneralizedTime> asSetOfGeneralizedTime(GeneralizedTime... defaultValues)
GeneralizedTime
s using the
generalized time syntax, or defaultValues
if the attribute does
not contain any values.defaultValues
- The default values to return if the attribute is empty.GeneralizedTime
s.public Set<Integer> asSetOfInteger(Collection<Integer> defaultValues)
Integer
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.Integer
s.public Set<Integer> asSetOfInteger(Integer... defaultValues)
Integer
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.Integer
s.public Set<Long> asSetOfLong(Collection<Long> defaultValues)
Long
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.Long
s.public Set<Long> asSetOfLong(Long... defaultValues)
Long
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.Long
s.public Set<String> asSetOfString(Collection<String> defaultValues)
String
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.String
s.public Set<String> asSetOfString(String... defaultValues)
String
s, or
defaultValues
if the attribute does not contain any values.defaultValues
- The default values to return if the attribute is empty.String
s.public String asString()
String
, or null
if
the attribute does not contain any values.String
.public String asString(String defaultValue)
String
, or
defaultValue
if the attribute does not contain any values.defaultValue
- The default value to return if the attribute is empty.String
.public AttributeParser requireValue()
LocalizedIllegalArgumentException
if the attribute referenced by this parser is null
or
empty.LocalizedIllegalArgumentException
- If the attribute referenced by this parser is null
or empty.public AttributeParser usingSchema(Schema schema)
Schema
which will be used when parsing schema sensitive
values such as DNs and attribute descriptions.schema
- The Schema
which will be used when parsing schema
sensitive values.Copyright 2010-2022 ForgeRock AS.