Package com.unboundid.ldap.sdk.persist

Class GetterInfo

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

  • Method Details

    • getMethod

      @NotNull public Method getMethod()
      Retrieves the method with which this object is associated.
      Returns:
      The method 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.

    • includeInAdd

      public boolean includeInAdd()
      Indicates whether the associated method value 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 method value should be included in entries generated for add operations, or false if not.

    • includeInModify

      public boolean includeInModify()
      Indicates whether the associated method value 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 have a value of true if the associated field is to be included in entry RDNs.
      Returns:
      true if the associated method value 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 method value should be used to generate entry RDNs.
      Returns:
      true if the associated method value should be used to generate entry RDNs, or false if not.

    • getFilterUsage

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

    • getEncoder

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

    • getAttributeName

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

    • 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.