com.ibm.commerce.condition

Class OpenCondition.Parameter

  • java.lang.Object
    • com.ibm.commerce.condition.OpenCondition.Parameter
  • All Implemented Interfaces:
    com.ibm.commerce.base.helpers.Uniquifiable, com.ibm.commerce.datatype.Hashable, com.ibm.websphere.cache.Sizeable, java.io.Serializable
    Enclosing class:
    OpenCondition

    public static final class OpenCondition.Parameter
extends java.lang.Object
implements com.ibm.commerce.base.helpers.Uniquifiable, java.io.Serializable, com.ibm.websphere.cache.Sizeable
    This class describes an open condition parameter. A parameter consists of a name, value and an optional list of parameters.
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface com.ibm.commerce.base.helpers.Uniquifiable

        COPYRIGHT

    • Constructor Summary

      Constructors 
      Constructor and Description
      Parameter(java.lang.String name, java.lang.String value)
      This constructor takes the name and value of the parameter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Object clone() 
      boolean equals(java.lang.Object aObject)
      Returns true if the specified object is equivalent to this object.
      java.lang.String getName()
      Get the name of this parameter.
      long getObjectSize()
      Returns the estimated footprint size in bytes of this object and the objects it contains.
      OpenCondition.Parameter[] getSubParameters()
      Gets the array of subparameters for this parameter.
      java.lang.String getValue()
      Gets the value for this parameter.
      int hashCode()
      Returns a hash code for this object.
      void setName(java.lang.String name)
      Sets the name of this parameter.
      void setSubParameters(OpenCondition.Parameter[] subParameters)
      Sets the subparameters for this parameter.
      void setValue(java.lang.String value)
      Sets the value of this parameter.
      void uniquify()
      Reduces memory footprint of this object.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Parameter

        public Parameter(java.lang.String name,
                 java.lang.String value)
        This constructor takes the name and value of the parameter.
        Parameters:
        name - The name of the parameter.
        value - The value of this parameter.

    • Method Detail

      • getObjectSize

        public long getObjectSize()
        Returns the estimated footprint size in bytes of this object and the objects it contains.
        Specified by:
        getObjectSize in interface com.ibm.websphere.cache.Sizeable
        Returns:
        the estimated footprint size in bytes or -1 if a size cannot be determined.

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object

      • getName

        public java.lang.String getName()
        Get the name of this parameter.
        Returns:
        The name of the parameter.

      • setName

        public void setName(java.lang.String name)
        Sets the name of this parameter.
        Parameters:
        name - The Name of this parameter.

      • getValue

        public java.lang.String getValue()
        Gets the value for this parameter.
        Returns:
        The value for the parameter.

      • setValue

        public void setValue(java.lang.String value)
        Sets the value of this parameter.
        Parameters:
        value - The value of the parameter.

      • getSubParameters

        public OpenCondition.Parameter[] getSubParameters()
        Gets the array of subparameters for this parameter.
        Returns:
        An array of Parameter objects.

      • setSubParameters

        public void setSubParameters(OpenCondition.Parameter[] subParameters)
        Sets the subparameters for this parameter.
        Parameters:
        subParameters - The subparameters for this parameter.

      • equals

        public boolean equals(java.lang.Object aObject)
        Returns true if the specified object is equivalent to this object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        aObject - the specified object.
        Returns:
        true if the specified object is equivalent to this object.

      • hashCode

        public int hashCode()
        Returns a hash code for this object. Equal objects must return the same hash code.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code.

      • uniquify

        public void uniquify()

        Reduces memory footprint of this object.

        It is expected that the implementation of this method will use the Uniquee class to replace some or all of its properties with equivalent values from the Uniquee cache, or, if equivalent values are not found, place this object's properties in the Uniquee cache.

        The caller must be able to promise that this object and its properties, recursively, will never be modified again, so that it and its properties can be shared by other objects.

        This method is intended to be called by the Uniquee class.

        Specified by:
        uniquify in interface com.ibm.commerce.base.helpers.Uniquifiable
Skip navigation links