Class AbstractObjectDescription

    • Field Detail

      • className

        private java.lang.Class className
        The class.
      • parameters

        private java.util.HashMap parameters
        Storage for parameters.
      • parameterDefs

        private java.util.HashMap parameterDefs
        Storage for parameter definitions.
      • config

        private Configuration config
        The configuration for the object description.
    • Constructor Detail

      • AbstractObjectDescription

        public AbstractObjectDescription​(java.lang.Class className)
        Creates a new object description.
        Parameters:
        className - the class.
    • Method Detail

      • getParameterDefinition

        public java.lang.Class getParameterDefinition​(java.lang.String name)
        Returns a parameter class.
        Specified by:
        getParameterDefinition in interface ObjectDescription
        Parameters:
        name - the parameter definition.
        Returns:
        The class.
      • setParameterDefinition

        public void setParameterDefinition​(java.lang.String name,
                                           java.lang.Class obj)
        Sets the class for a parameter.
        Parameters:
        name - the parameter name.
        obj - the parameter class.
      • convertPrimitiveClass

        public static java.lang.Class convertPrimitiveClass​(java.lang.Class obj)
        Converts primitives to corresponding object class.
        Parameters:
        obj - the class.
        Returns:
        The class.
      • setParameter

        public void setParameter​(java.lang.String name,
                                 java.lang.Object value)
        Sets a parameter.
        Specified by:
        setParameter in interface ObjectDescription
        Parameters:
        name - the name.
        value - the value.
      • getParameterNames

        public java.util.Iterator getParameterNames()
        Returns an iterator for the parameter names.
        Specified by:
        getParameterNames in interface ObjectDescription
        Returns:
        The iterator.
      • getDefinedParameterNames

        protected java.util.Iterator getDefinedParameterNames()
        Returns an iterator for the parameter names.
        Returns:
        The iterator.
      • getParameter

        public java.lang.Object getParameter​(java.lang.String name)
        Returns a parameter value.
        Specified by:
        getParameter in interface ObjectDescription
        Parameters:
        name - the parameter name.
        Returns:
        The parameter value.
      • getObjectClass

        public java.lang.Class getObjectClass()
        Returns the class for the object.
        Specified by:
        getObjectClass in interface ObjectDescription
        Returns:
        The class.
      • getInstance

        public ObjectDescription getInstance()
        Returns a cloned instance of the object description. The contents of the parameter objects collection are cloned too, so that any already defined parameter value is copied to the new instance.

        Parameter definitions are not cloned, as they are considered read-only.

        The newly instantiated object description is not configured. If it need to be configured, then you have to call configure on it.

        Specified by:
        getInstance in interface ObjectDescription
        Returns:
        A cloned instance.
      • getUnconfiguredInstance

        public ObjectDescription getUnconfiguredInstance()
        Returns a cloned instance of the object description. The contents of the parameter objects collection are cloned too, so that any already defined parameter value is copied to the new instance.

        Parameter definitions are not cloned, as they are considered read-only.

        The newly instantiated object description is not configured. If it need to be configured, then you have to call configure on it.

        Specified by:
        getUnconfiguredInstance in interface ObjectDescription
        Returns:
        A cloned instance.
      • configure

        public void configure​(Configuration config)
        Configures this factory. The configuration contains several keys and their defined values. The given reference to the configuration object will remain valid until the report parsing or writing ends.

        The configuration contents may change during the reporting.

        Specified by:
        configure in interface ObjectDescription
        Parameters:
        config - the configuration, never null
      • getConfig

        public Configuration getConfig()
        Returns the configuration for that object description.
        Returns:
        the configuration or null, if not yet set.
      • equals

        public boolean equals​(java.lang.Object o)
        Tests for equality.
        Specified by:
        equals in interface ObjectDescription
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - the object to test.
        Returns:
        A boolean.
      • hashCode

        public int hashCode()
        Returns a hash code for the object.
        Specified by:
        hashCode in interface ObjectDescription
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code.