Package org.exolab.castor.xml

Class XMLFieldHandler

    • Constructor Summary

      Constructors 
      Constructor Description
      XMLFieldHandler()
      Creates a new default XMLFieldHandler

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Returns true if the given object is an XMLFieldHandler that is equivalent to this one.
      java.lang.Object getValue​(java.lang.Object object)
      Returns the value of the field from the object.
      java.lang.Object newInstance​(java.lang.Object parent)
      Creates a new instance of the object described by this field.
      java.lang.Object newInstance​(java.lang.Object parent, java.lang.Object[] args)
      Creates a new instance of the object described by this field.
      void resetValue​(java.lang.Object object)
      Sets the value of the field to a default value.
      void setValue​(java.lang.Object object, java.lang.Object value)
      Sets the value of the field on the object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • XMLFieldHandler

        public XMLFieldHandler()
        Creates a new default XMLFieldHandler

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Returns true if the given object is an XMLFieldHandler that is equivalent to this one. An equivalent XMLFieldHandler is an XMLFieldHandler that is an instances of the same class. This method can be overwritten to provide more advanced equivalence tests.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true if the given object is an XMLFieldHandler that is equivalent to this one.

      • getValue

        public java.lang.Object getValue​(java.lang.Object object)
                          throws java.lang.IllegalStateException
        Returns the value of the field from the object.
        Specified by:
        getValue in interface FieldHandler
        Specified by:
        getValue in class FieldHandlerFriend
        Parameters:
        object - The object
        Returns:
        The value of the field
        Throws:
        java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

      • newInstance

        public java.lang.Object newInstance​(java.lang.Object parent)
                             throws java.lang.IllegalStateException
        Creates a new instance of the object described by this field.
        Specified by:
        newInstance in interface FieldHandler
        Specified by:
        newInstance in class FieldHandlerFriend
        Parameters:
        parent - The object for which the field is created
        Returns:
        A new instance of the field's value
        Throws:
        java.lang.IllegalStateException - This field is a simple type and cannot be instantiated

      • newInstance

        public java.lang.Object newInstance​(java.lang.Object parent,
                                    java.lang.Object[] args)
                             throws java.lang.IllegalStateException
        Creates a new instance of the object described by this field.
        Specified by:
        newInstance in class ExtendedFieldHandler
        Parameters:
        parent - The object for which the field is created
        args - the set of constructor arguments
        Returns:
        A new instance of the field's value
        Throws:
        java.lang.IllegalStateException - This field is a simple type and cannot be instantiated

      • setValue

        public void setValue​(java.lang.Object object,
                     java.lang.Object value)
              throws java.lang.IllegalStateException,
                     java.lang.IllegalArgumentException
        Sets the value of the field on the object.
        Specified by:
        setValue in interface FieldHandler
        Specified by:
        setValue in class FieldHandlerFriend
        Parameters:
        object - The object.
        value - The new value.
        Throws:
        java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object.
        java.lang.IllegalArgumentException - The value passed is not of a supported type.

      • resetValue

        public void resetValue​(java.lang.Object object)
                throws java.lang.IllegalStateException,
                       java.lang.IllegalArgumentException
        Description copied from class: FieldHandlerFriend
        Sets the value of the field to a default value.

        Reference fields are set to null, primitive fields are set to their default value, collection fields are emptied of all elements.

        Specified by:
        resetValue in interface FieldHandler
        Specified by:
        resetValue in class FieldHandlerFriend
        Parameters:
        object - The object
        Throws:
        java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object
        java.lang.IllegalArgumentException