Package com.unboundid.ldap.sdk.persist

Class SetterInfo

java.lang.Object
com.unboundid.ldap.sdk.persist.SetterInfo
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SetterInfo extends Object implements Serializable
This class provides a data structure that holds information about an annotated setter method.
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 represented in the argument type for the associated method.
    boolean
    failOnTooManyValues()
    Indicates whether attempts to initialize an object should fail if the LDAP attribute has multiple values but the associated method argument can only hold a single value.
    String
    getAttributeName()
    Retrieves the name of the LDAP attribute used to hold values for the associated method.
    Class<?>
    getContainingClass()
    Retrieves the class that is marked with the LDAPObject annotation and contains the associated field.
    ObjectEncoder
    getEncoder()
    Retrieves the encoder that should be used for the associated method.
    Method
    getMethod()
    Retrieves the method with which this object is associated.
    boolean
    supportsMultipleValues()
    Indicates whether the associated method takes an argument that can hold multiple values.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

    • failOnInvalidValue

      public boolean failOnInvalidValue()
      Indicates whether attempts to initialize an object should fail if the LDAP attribute has a value that cannot be represented in the argument type for the associated method.
      Returns:
      true if an exception should be thrown if an LDAP attribute has a value that cannot be provided as an argument to the associated method, or false if the method should not be invoked.

    • failOnTooManyValues

      public boolean failOnTooManyValues()
      Indicates whether attempts to initialize an object should fail if the LDAP attribute has multiple values but the associated method argument 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 method takes an argument that supports multiple values.
      Returns:
      true if an exception should be thrown if an attribute has too many values to provide to the associated method, or false if the first value returned should be provided as an argument to 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.

    • supportsMultipleValues

      public boolean supportsMultipleValues()
      Indicates whether the associated method takes an argument that can hold multiple values.
      Returns:
      true if the associated method takes an argument that can hold multiple values, or false if not.