Class TestVariable

  • All Implemented Interfaces:
    InequalityTerm

    public class TestVariable
    extends java.lang.Object
    implements InequalityTerm
    A variable InequalityTerm. This class is for testing inequality related classes. The value of this InequalityTerm is a String. This term has name, which is used for printing test result.
    Since:
    Ptolemy II 0.2
    Version:
    $Id$
    Author:
    Yuhong Xiong
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)
    • Constructor Summary

      Constructors 
      Constructor Description
      TestVariable()
      Construct a variable InequalityTerm with a null initial value.
      TestVariable​(java.lang.String value)
      Construct a variable InequalityTerm with the specified initial value.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void fixValue()
      Disallow the value of this term to be set.
      java.lang.Object getAssociatedObject()
      Return the string value.
      java.lang.String getInfo()
      Return the information of this term.
      java.lang.Object getValue()
      Return the String value of this term.
      InequalityTerm[] getVariables()
      Return an array of size one.
      void initialize​(java.lang.Object e)
      Set the value of this variable to the specified String.
      boolean isSettable()
      Return true.
      boolean isValueAcceptable()
      Check whether the current value of this term is acceptable, and return true if it is.
      void setName​(java.lang.String name)
      Set the name of this variable.
      void setValue​(java.lang.Object e)
      Set the value of this variable to the specified String.
      java.lang.String toString()
      Override the base class to describe the variable.
      void unfixValue()
      Allow the value of this term to be changed.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TestVariable

        public TestVariable()
        Construct a variable InequalityTerm with a null initial value.
      • TestVariable

        public TestVariable​(java.lang.String value)
        Construct a variable InequalityTerm with the specified initial value.
        Parameters:
        value - A String
    • Method Detail

      • fixValue

        public void fixValue()
        Disallow the value of this term to be set.
      • getAssociatedObject

        public java.lang.Object getAssociatedObject()
        Return the string value.
        Specified by:
        getAssociatedObject in interface InequalityTerm
        Returns:
        A String
      • getInfo

        public java.lang.String getInfo()
        Return the information of this term. The information is a String of the form: name(variable)_value.
        Returns:
        A String
      • getVariables

        public InequalityTerm[] getVariables()
        Return an array of size one. The element of the array is the this reference.
        Specified by:
        getVariables in interface InequalityTerm
        Returns:
        an array of InequalityTerms
      • isSettable

        public boolean isSettable()
        Return true.
        Specified by:
        isSettable in interface InequalityTerm
        Returns:
        true
      • isValueAcceptable

        public boolean isValueAcceptable()
        Check whether the current value of this term is acceptable, and return true if it is. In this class, a value is always acceptable.
        Specified by:
        isValueAcceptable in interface InequalityTerm
        Returns:
        True.
      • setName

        public void setName​(java.lang.String name)
        Set the name of this variable. If the specified String is null, Set the name to an empty String.
        Parameters:
        name - The name of this variable.
      • toString

        public java.lang.String toString()
        Override the base class to describe the variable.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string describing the variable.
      • unfixValue

        public void unfixValue()
        Allow the value of this term to be changed.