|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.Attribute
org.opends.server.types.VirtualAttribute
@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class VirtualAttribute
This class defines a virtual attribute, which is a special kind of attribute whose values do not actually exist in persistent storage but rather are computed or otherwise obtained dynamically.
Constructor Summary | |
---|---|
VirtualAttribute(AttributeType attributeType,
Entry entry,
VirtualAttributeRule rule)
Creates a new virtual attribute with the provided information. |
Method Summary | |
---|---|
ConditionResult |
approximatelyEqualTo(AttributeValue value)
Indicates whether this attribute has any value(s) that are approximately equal to the provided value. |
Attribute |
duplicate(boolean omitValues)
Creates a duplicate of this attribute that can be modified without impacting this attribute. |
Entry |
getEntry()
Retrieves the entry in which this virtual attribute exists. |
java.util.LinkedHashSet<AttributeValue> |
getValues()
Retrieves the set of values for this attribute. |
VirtualAttributeRule |
getVirtualAttributeRule()
Retrieves the virtual attribute rule that governs the behavior of this virtual attribute. |
ConditionResult |
greaterThanOrEqualTo(AttributeValue value)
Indicates whether this attribute has any value(s) that are greater than or equal to the provided value. |
boolean |
hasAllValues(java.util.Collection<AttributeValue> values)
Indicates whether this attribute contains all the values in the collection. |
boolean |
hasAnyValue(java.util.Collection<AttributeValue> values)
Indicates whether this attribute contains any of the values in the collection. |
boolean |
hasValue()
Indicates whether this attribute contains one or more values. |
boolean |
hasValue(AttributeValue value)
Indicates whether this attribute contains the specified value. |
boolean |
isVirtual()
Indicates whether this is a virtual attribute rather than a real attribute. |
ConditionResult |
lessThanOrEqualTo(AttributeValue value)
Indicates whether this attribute has any value(s) that are less than or equal to the provided value. |
ConditionResult |
matchesSubstring(ByteString subInitial,
java.util.List<ByteString> subAny,
ByteString subFinal)
Indicates whether this attribute has any value(s) that match the provided substring. |
void |
toString(java.lang.StringBuilder buffer)
Appends a one-line string representation of this attribute to the provided buffer. |
Methods inherited from class org.opends.server.types.Attribute |
---|
duplicate, equals, getAttributeType, getName, getNameWithOptions, getOptions, hashCode, hasOption, hasOptions, hasOptions, optionsEqual, setValues, toLDIF, toLDIF, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public VirtualAttribute(AttributeType attributeType, Entry entry, VirtualAttributeRule rule)
attributeType
- The attribute type for this virtual
attribute.entry
- The entry in which this virtual attribute
exists.rule
- The virutal attribute rule that governs
the behavior of this virtual attribute.Method Detail |
---|
public Entry getEntry()
public VirtualAttributeRule getVirtualAttributeRule()
public java.util.LinkedHashSet<AttributeValue> getValues()
getValues
in class Attribute
public boolean hasValue()
hasValue
in class Attribute
true
if this attribute contains one or more
values, or false
if it does not.public boolean hasValue(AttributeValue value)
hasValue
in class Attribute
value
- The value for which to make the determination.
true
if this attribute has the specified
value, or false
if not.public boolean hasAllValues(java.util.Collection<AttributeValue> values)
hasAllValues
in class Attribute
values
- The set of values for which to make the
determination.
true
if this attribute contains all the
values in the provided collection, or false
if it does not contain at least one of them.public boolean hasAnyValue(java.util.Collection<AttributeValue> values)
hasAnyValue
in class Attribute
values
- The set of values for which to make the
determination.
true
if this attribute contains at least
one of the values in the provided collection, or
false
if it does not contain any of the
values.public ConditionResult matchesSubstring(ByteString subInitial, java.util.List<ByteString> subAny, ByteString subFinal)
matchesSubstring
in class Attribute
subInitial
- The subInitial component to use in the
determination.subAny
- The subAny components to use in the
determination.subFinal
- The subFinal component to use in the
determination.
UNDEFINED
if this attribute does not have a
substring matching rule, TRUE
if at least
one value matches the provided substring, or
FALSE
otherwise.public ConditionResult greaterThanOrEqualTo(AttributeValue value)
greaterThanOrEqualTo
in class Attribute
value
- The value for which to make the determination.
UNDEFINED
if this attribute does not have
an ordering matching rule, TRUE
if at least
one value is greater than or equal to the provided
value, or false
otherwise.public ConditionResult lessThanOrEqualTo(AttributeValue value)
lessThanOrEqualTo
in class Attribute
value
- The value for which to make the determination.
UNDEFINED
if this attribute does not have
an ordering matching rule, TRUE
if at least
one value is less than or equal to the provided value,
or false
otherwise.public ConditionResult approximatelyEqualTo(AttributeValue value)
approximatelyEqualTo
in class Attribute
value
- The value for which to make the determination.
UNDEFINED
if this attribute does not have
an approximate matching rule, TRUE
if at
least one value is approximately equal to the provided
value, or false
otherwise.public boolean isVirtual()
isVirtual
in class Attribute
true
if this is a virtual attribute, or
false
if it is a real attribute.public Attribute duplicate(boolean omitValues)
duplicate
in class Attribute
omitValues
- true
if the values should be
omitted.
public void toString(java.lang.StringBuilder buffer)
toString
in class Attribute
buffer
- The buffer to which the information should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |