|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.persist.FieldInfo
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class FieldInfo
This class provides a data structure that holds information about an annotated field.
Method Summary | |
---|---|
boolean |
failOnInvalidValue()
Indicates whether attempts to initialize an object should fail if the LDAP attribute has a value that cannot be stored in the associated field. |
boolean |
failOnTooManyValues()
Indicates whether attempts to initialize an object should fail if the LDAP attribute has multiple values but the associated field can only hold a single value. |
java.lang.String |
getAttributeName()
Retrieves the name of the LDAP attribute used to hold values for the associated field. |
java.lang.Class<?> |
getContainingClass()
Retrieves the class that is marked with the LDAPObject annotation
and contains the associated field. |
java.lang.String[] |
getDefaultDecodeValues()
Retrieves the set of default values that should be assigned to the associated field if there are no values for the corresponding attribute in the LDAP entry. |
java.lang.String[] |
getDefaultEncodeValues()
Retrieves the set of default values that should be used when creating an entry for an add operation if the associated field does not itself have any values. |
ObjectEncoder |
getEncoder()
Retrieves the encoder that should be used for the associated field. |
java.lang.reflect.Field |
getField()
Retrieves the field with which this object is associated. |
FilterUsage |
getFilterUsage()
Retrieves the filter usage for the associated field. |
java.lang.String[] |
getObjectClasses()
Retrieves the names of the object classes containing the associated attribute. |
boolean |
includeInAdd()
Indicates whether the associated field should be included in entries generated for add operations. |
boolean |
includeInModify()
Indicates whether the associated field should be considered for inclusion in the set of modifications generated for modify operations. |
boolean |
includeInRDN()
Indicates whether the associated field should be used to generate entry RDNs. |
boolean |
isRequiredForDecode()
Indicates whether the associated field should be considered required for decode operations. |
boolean |
isRequiredForEncode()
Indicates whether the associated field should be considered required for encode operations. |
boolean |
lazilyLoad()
Indicates whether the associated field should be lazily-loaded. |
boolean |
supportsMultipleValues()
Indicates whether the associated field can hold multiple values. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.reflect.Field getField()
public java.lang.Class<?> getContainingClass()
LDAPObject
annotation
and contains the associated field.
public boolean failOnInvalidValue()
true
if an exception should be thrown if an LDAP attribute
has a value that cannot be assigned to the associated field, or
false
if the field should remain uninitialized.public boolean failOnTooManyValues()
false
even when the annotation has a value of true
if the
associated field supports multiple values.
true
if an exception should be thrown if an attribute has
too many values to hold in the associated field, or false
if the first value returned should be assigned to the field.public boolean includeInAdd()
true
even when the annotation has a value of
false
if the associated field is to be included in entry RDNs.
true
if the associated field should be included in entries
generated for add operations, or false
if not.public boolean includeInModify()
false
even when the
annotation has a value of true
for the inModify
element if
the associated field is to be included in entry RDNs.
true
if the associated field should be considered for
inclusion in the set of modifications generated for modify
operations, or false
if not.public boolean includeInRDN()
true
if the associated field should be used to generate
entry RDNs, or false
if not.public FilterUsage getFilterUsage()
public boolean isRequiredForDecode()
true
if the associated field should be considered required
for decode operations, or false
if not.public boolean isRequiredForEncode()
true
even when the annotation has a value of true
for the
requiredForEncode
element if the associated field is to be included
in entry RDNs.
true
if the associated field should be considered required
for encode operations, or false
if not.public boolean lazilyLoad()
true
if the associated field should be lazily-loaded, or
false
if not.public ObjectEncoder getEncoder()
public java.lang.String getAttributeName()
public java.lang.String[] getDefaultDecodeValues()
public java.lang.String[] getDefaultEncodeValues()
public java.lang.String[] getObjectClasses()
public boolean supportsMultipleValues()
true
if the associated field can hold multiple values, or
false
if not.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |