Class ArrayInstance

java.lang.Object
org.simpleframework.xml.core.ArrayInstance
All Implemented Interfaces:
Instance

class ArrayInstance extends Object implements Instance
The ArrayInstance object is used for creating arrays from a specified Value object. This allows primitive and composite arrays to be acquired either by reference or by value from the given value object. This must be given the length of the array so that it can be allocated correctly.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    This is the length of the array to be instantiated.
    private final Class
    This is the array component type for the created array.
    private final Value
    This is the value object that contains the criteria.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor for the ArrayInstance object.
  • Method Summary

    Modifier and Type
    Method
    Description
    This method is used to acquire an instance of the type that is defined by this object.
    This is the type of the object instance that will be created by the getInstance method.
    boolean
    This is used to determine if the type is a reference type.
    This method is used acquire the value from the type and if possible replace the value for the type.

    Methods inherited from class java.lang.Object

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

    • value

      private final Value value
      This is the value object that contains the criteria.
    • type

      private final Class type
      This is the array component type for the created array.
    • length

      private final int length
      This is the length of the array to be instantiated.
  • Constructor Details

    • ArrayInstance

      public ArrayInstance(Value value)
      Constructor for the ArrayInstance object. This is used to create an object that can create an array of the given length and specified component type.
      Parameters:
      value - this is the value object describing the instance
  • Method Details

    • getInstance

      public Object getInstance() throws Exception
      This method is used to acquire an instance of the type that is defined by this object. If for some reason the type can not be instantiated an exception is thrown from this.
      Specified by:
      getInstance in interface Instance
      Returns:
      an instance of the type this object represents
      Throws:
      Exception
    • setInstance

      public Object setInstance(Object array)
      This method is used acquire the value from the type and if possible replace the value for the type. If the value can not be replaced then an exception should be thrown. This is used to allow primitives to be inserted into a graph.
      Specified by:
      setInstance in interface Instance
      Parameters:
      array - this is the array to insert as the value
      Returns:
      an instance of the type this object represents
    • getType

      public Class getType()
      This is the type of the object instance that will be created by the getInstance method. This allows the deserialization process to perform checks against the field.
      Specified by:
      getType in interface Instance
      Returns:
      the type of the object that will be instantiated
    • isReference

      public boolean isReference()
      This is used to determine if the type is a reference type. A reference type is a type that does not require any XML deserialization based on its annotations. Values that are references could be substitutes objects of existing ones.
      Specified by:
      isReference in interface Instance
      Returns:
      this returns true if the object is a reference