Package com.unboundid.ldap.sdk.persist
Class GetterInfo
- java.lang.Object
-
- com.unboundid.ldap.sdk.persist.GetterInfo
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetterInfo extends java.lang.Object implements java.io.Serializable
This class provides a data structure that holds information about an annotated getter method.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAttributeName()
Retrieves the name of the LDAP attribute used to hold values for the associated method.java.lang.Class<?>
getContainingClass()
Retrieves the class that is marked with theLDAPObject
annotation and contains the associated field.ObjectEncoder
getEncoder()
Retrieves the encoder that should be used for the associated method.FilterUsage
getFilterUsage()
Retrieves the filter usage for the associated method.java.lang.reflect.Method
getMethod()
Retrieves the method with which this object is associated.java.lang.String[]
getObjectClasses()
Retrieves the names of the object classes containing the associated attribute.boolean
includeInAdd()
Indicates whether the associated method value should be included in entries generated for add operations.boolean
includeInModify()
Indicates whether the associated method value should be considered for inclusion in the set of modifications generated for modify operations.boolean
includeInRDN()
Indicates whether the associated method value should be used to generate entry RDNs.
-
-
-
Method Detail
-
getMethod
@NotNull public java.lang.reflect.Method getMethod()
Retrieves the method with which this object is associated.- Returns:
- The method with which this object is associated.
-
getContainingClass
@NotNull public java.lang.Class<?> getContainingClass()
Retrieves the class that is marked with theLDAPObject
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 betrue
even when the annotation has a value offalse
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, orfalse
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 befalse
even when the annotation have a value oftrue
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, orfalse
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, orfalse
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 java.lang.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 java.lang.String[] getObjectClasses()
Retrieves the names of the object classes containing the associated attribute.- Returns:
- The names of the object classes containing the associated attribute.
-
-