Package ptolemy.data.type.test

Class TestToken

java.lang.Object

ptolemy.data.Token

ptolemy.data.type.test.TestToken

public class TestToken
extends Token

This is a new type of token. It is used to test the TypeLattice to ensure that unspecified token types are allowed, and simply made incomparable to everything else.

Since:

Ptolemy II 2.0

Version:

$Id$

Author:

Steve Neuendorffer

Pt.AcceptedRating:

Red (neuendor)

Pt.ProposedRating:

Red (neuendor)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestToken.TestType	The class of this token.

Field Summary

Fields

Modifier and Type	Field	Description
static Type	TYPE	The type of this token.

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor	Description
TestToken(java.lang.Object object)	Construct a token to be used for testing that encapsulates an object.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getObject()	Return the object contained by this token.
Type	getType()	Return the type of this token.
BooleanToken	isEqualTo(Token token)	Test for equality of the values of this Token and the argument Token.
java.lang.String	toString()	Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value.

Methods inherited from class ptolemy.data.Token

add, addReverse, divide, divideReverse, isCloseTo, isCloseTo, isNil, modulo, moduloReverse, multiply, multiplyReverse, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, notSupportedNullNilStringMessage, one, pow, subtract, subtractReverse, zero, zeroReturnType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final Type TYPE

The type of this token.

Constructor Detail

TestToken

public TestToken(java.lang.Object object)

Construct a token to be used for testing that encapsulates an object.

Parameters:

object - The object to be encapsulated

Method Detail

getObject

public java.lang.Object getObject()

Return the object contained by this token.

Returns:

The object.

getType

public Type getType()

Return the type of this token.

Overrides:

getType in class Token

Returns:

TYPE, the type of this token.

isEqualTo

public BooleanToken isEqualTo(Token token)
                       throws IllegalActionException

Test for equality of the values of this Token and the argument Token. It should be overridden in derived classes to provide type specific actions for equality testing.

Overrides:

isEqualTo in class Token

Parameters:

token - The token with which to test equality.

Returns:

A BooleanToken which contains the result of the test.

Throws:

IllegalActionException - If this method is not supported by the derived class.

toString

public java.lang.String toString()

Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value. This method should be overridden by derived classes. In this base class, return the String "present" to indicate that an event is present.

Overrides:

toString in class Token

Returns:

The String "present".