Class GetPart

java.lang.Object
org.simpleframework.xml.core.GetPart
All Implemented Interfaces:
MethodPart

class GetPart extends Object implements MethodPart
The GetPart object represents the getter method for a Java Bean property. This composes the get part of the method contact for an object. The get part contains the method that is used to get the value in an object and the annotation that tells the serialization process how to serialize the value.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Cache<Annotation>
    This cache contains the annotations present on the method.
    private final Annotation
    This is the annotation for the get method provided.
    private final Annotation[]
    This is the list of annotations associated with the method.
    private final Method
    This method is used to get the value during serialization.
    private final String
    This is the Java Bean name representation of the method.
    private final MethodType
    This represents the method type for the get part method.
  • Constructor Summary

    Constructors
    Constructor
    Description
    GetPart(MethodName method, Annotation label, Annotation[] list)
    Constructor for the GetPart object.
  • Method Summary

    Modifier and Type
    Method
    Description
    This is used to acquire the annotation that was used to label the method this represents.
    <T extends Annotation>
    T
    This is the annotation associated with the point of contact.
    This is the class that declares the contact.
    This is used to acquire the dependent class for the method part.
    This is used to acquire the dependent classes for the method part.
    This is used to acquire the method that can be used to invoke the Java Bean method on the object.
    This is the method type for the method part.
    This provides the name of the method part as acquired from the method name.
    This is used to acquire the type for this method part.
    This is used to describe the method as it exists within the owning class.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • cache

      private final Cache<Annotation> cache
      This cache contains the annotations present on the method.
    • list

      private final Annotation[] list
      This is the list of annotations associated with the method.
    • label

      private final Annotation label
      This is the annotation for the get method provided.
    • type

      private final MethodType type
      This represents the method type for the get part method.
    • method

      private final Method method
      This method is used to get the value during serialization.
    • name

      private final String name
      This is the Java Bean name representation of the method.
  • Constructor Details

    • GetPart

      public GetPart(MethodName method, Annotation label, Annotation[] list)
      Constructor for the GetPart object. This is used to create a method part that will provide a means for the serialization process to set a value to a object.
      Parameters:
      method - the method that is used to get the value
      label - this describes how to serialize the value
      list - this is the list of annotations on the method
  • Method Details

    • getName

      public String getName()
      This provides the name of the method part as acquired from the method name. The name represents the Java Bean property name of the method and is used to pair getter and setter methods.
      Specified by:
      getName in interface MethodPart
      Returns:
      this returns the Java Bean name of the method part
    • getType

      public Class getType()
      This is used to acquire the type for this method part. This is used by the serializer to determine the schema class that is used to match the XML elements to the object details.
      Specified by:
      getType in interface MethodPart
      Returns:
      this returns the schema class for this method
    • getDependent

      public Class getDependent()
      This is used to acquire the dependent class for the method part. The dependent type is the type that represents the generic type of the type. This is used when collections are annotated as it allows a default entry class to be taken from the generic information provided.
      Specified by:
      getDependent in interface MethodPart
      Returns:
      this returns the generic dependent for the type
    • getDependents

      public Class[] getDependents()
      This is used to acquire the dependent classes for the method part. The dependent types are the types that represent the generic types of the type. This is used when collections are annotated as it allows a default entry class to be taken from the generic information provided.
      Specified by:
      getDependents in interface MethodPart
      Returns:
      this returns the generic dependent for the type
    • getDeclaringClass

      public Class getDeclaringClass()
      This is the class that declares the contact. The declaring class is where the method represented has been defined. This will typically be a class rather than an interface.
      Specified by:
      getDeclaringClass in interface MethodPart
      Returns:
      this returns the class the part is declared within
    • getAnnotation

      public Annotation getAnnotation()
      This is used to acquire the annotation that was used to label the method this represents. This acts as a means to match the set method with the get method using an annotation comparison.
      Specified by:
      getAnnotation in interface MethodPart
      Returns:
      this returns the annotation used to mark the method
    • getAnnotation

      public <T extends Annotation> T getAnnotation(Class<T> type)
      This is the annotation associated with the point of contact. This will be an XML annotation that describes how the contact should be serialized and deserialized from the object.
      Specified by:
      getAnnotation in interface MethodPart
      Parameters:
      type - this is the type of the annotation to acquire
      Returns:
      this provides the annotation associated with this
    • getMethodType

      public MethodType getMethodType()
      This is the method type for the method part. This is used in the scanning process to determine which type of method a instance represents, this allows set and get methods to be paired.
      Specified by:
      getMethodType in interface MethodPart
      Returns:
      the method type that this part represents
    • getMethod

      public Method getMethod()
      This is used to acquire the method that can be used to invoke the Java Bean method on the object. If the method represented by this is inaccessible then this will set it as accessible.
      Specified by:
      getMethod in interface MethodPart
      Returns:
      returns the method used to interface with the object
    • toString

      public String toString()
      This is used to describe the method as it exists within the owning class. This is used to provide error messages that can be used to debug issues that occur when processing a method. This returns the method as a generic string representation.
      Specified by:
      toString in interface MethodPart
      Overrides:
      toString in class Object
      Returns:
      this returns a string representation of the method