Package ptolemy.kernel.attributes

Class RequireVersion

  • All Implemented Interfaces:
    java.lang.Cloneable, java.lang.Comparable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable
    public class RequireVersion
extends VersionAttribute
    An attribute that requires a particular version of Ptolemy II. When the value of this attribute is set (via setExpression()), the value that is set is compared against the version of the currently executing Ptolemy II installation. If the executing version is less than the value set, we throw an expression.

    Since:
    Ptolemy II 2.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (eal)

    • Constructor Detail

      • RequireVersion

        public RequireVersion​(NamedObj container,
                      java.lang.String name)
               throws IllegalActionException,
                      NameDuplicationException
        Construct an attribute with the given name contained by the specified container. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.
        Parameters:
        container - The container.
        name - The name of this attribute.
        Throws:
        IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.
        NameDuplicationException - If the name coincides with an attribute already in the container.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object object)
        Return true if the hash code of this object is equal (==) to the hash code of the argument.
        Overrides:
        equals in class VersionAttribute
        Parameters:
        object - The specified object that is compared against.
        Returns:
        True if the specified version is the same as this one.

      • hashCode

        public int hashCode()
        Return a hash code value for attribute. This method returns the identity hash code for this attribute. The hashCode() method of the super class is not called.
        Overrides:
        hashCode in class VersionAttribute
        Returns:
        A hash code value for this token.

      • setExpression

        public void setExpression​(java.lang.String expression)
                   throws IllegalActionException
        Set the required version, check it against the currently executing version, and throw an exception if the executing version is older.
        Specified by:
        setExpression in interface Settable
        Overrides:
        setExpression in class VersionAttribute
        Parameters:
        expression - The version string, consisting of version ID tuples separated by '.', '-' or '_'. For example: "1.2", "1.2_beta-4".
        Throws:
        IllegalActionException - If the argument contains a space, which violates the JNLP Version format specification, and if the specified version is newer than the executing version.
        See Also:
        StringAttribute.getExpression()