Package com.unboundid.ldap.sdk.persist

Class FieldInfo

java.lang.Object
com.unboundid.ldap.sdk.persist.FieldInfo
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class FieldInfo extends Object implements Serializable
This class provides a data structure that holds information about an annotated field.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    getAttributeName()
    Retrieves the name of the LDAP attribute used to hold values for the associated field.
    Class<?>
    getContainingClass()
    Retrieves the class that is marked with the LDAPObject annotation and contains the associated field.
    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.
    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.
    Field
    getField()
    Retrieves the field with which this object is associated.
    FilterUsage
    getFilterUsage()
    Retrieves the filter usage for the associated field.
    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 Details

    • getField

      @NotNull public Field getField()
      Retrieves the field with which this object is associated.
      Returns:
      The field with which this object is associated.

    • getContainingClass

      @NotNull public Class<?> getContainingClass()
      Retrieves the class that is marked with the LDAPObject annotation and contains the associated field.
      Returns:
      The class that contains the associated field.

    • failOnInvalidValue

      public 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.
      Returns:
      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.

    • failOnTooManyValues

      public 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. Note that the value returned from this method may be false even when the annotation has a value of true if the associated field supports multiple values.
      Returns:
      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.

    • includeInAdd

      public boolean includeInAdd()
      Indicates whether the associated field should be included in entries generated for add operations. Note that the value returned from this method may be true even when the annotation has a value of false if the associated field is to be included in entry RDNs.
      Returns:
      true if the associated field should be included in entries generated for add operations, or false if not.

    • includeInModify

      public boolean includeInModify()
      Indicates whether the associated field should be considered for inclusion in the set of modifications generated for modify operations. Note that the value returned from this method may be 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.
      Returns:
      true if the associated field should be considered for inclusion in the set of modifications generated for modify operations, or false if not.

    • includeInRDN

      public boolean includeInRDN()
      Indicates whether the associated field should be used to generate entry RDNs.
      Returns:
      true if the associated field should be used to generate entry RDNs, or false if not.

    • getFilterUsage

      @NotNull public FilterUsage getFilterUsage()
      Retrieves the filter usage for the associated field.
      Returns:
      The filter usage for the associated field.

    • isRequiredForDecode

      public boolean isRequiredForDecode()
      Indicates whether the associated field should be considered required for decode operations.
      Returns:
      true if the associated field should be considered required for decode operations, or false if not.

    • isRequiredForEncode

      public boolean isRequiredForEncode()
      Indicates whether the associated field should be considered required for encode operations. Note that the value returned from this method may be 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.
      Returns:
      true if the associated field should be considered required for encode operations, or false if not.

    • lazilyLoad

      public boolean lazilyLoad()
      Indicates whether the associated field should be lazily-loaded.
      Returns:
      true if the associated field should be lazily-loaded, or false if not.

    • getEncoder

      @NotNull public ObjectEncoder getEncoder()
      Retrieves the encoder that should be used for the associated field.
      Returns:
      The encoder that should be used for the associated field.

    • getAttributeName

      @NotNull public String getAttributeName()
      Retrieves the name of the LDAP attribute used to hold values for the associated field.
      Returns:
      The name of the LDAP attribute used to hold values for the associated field.

    • getDefaultDecodeValues

      @NotNull public 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.
      Returns:
      The set of default values for use when instantiating the object, or an empty array if no default values are defined.

    • getDefaultEncodeValues

      @NotNull public 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.
      Returns:
      The set of default values for use in add operations, or an empty array if no default values are defined.

    • getObjectClasses

      @NotNull public String[] getObjectClasses()
      Retrieves the names of the object classes containing the associated attribute.
      Returns:
      The names of the object classes containing the associated attribute.

    • supportsMultipleValues

      public boolean supportsMultipleValues()
      Indicates whether the associated field can hold multiple values.
      Returns:
      true if the associated field can hold multiple values, or false if not.