ptolemy.data

Class AWTImageToken

java.lang.Object

ptolemy.data.Token

ptolemy.data.ObjectToken

ptolemy.data.ImageToken

ptolemy.data.AWTImageToken

public class AWTImageToken
extends ImageToken

A token that contains a java.awt.Image. This token is used in the standard image processing library.

Since:

Ptolemy II 3.0

Version:

$Id$

Author:

James Yeh

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Field Summary

Fields inherited from class ptolemy.data.ObjectToken

_class, _value, NULL

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor and Description
AWTImageToken(java.awt.Image value) Construct a token with a specified java.awt.Image.

Method Summary

Modifier and Type	Method and Description
java.awt.Image	asAWTImage() Because all tokens that contain images must extend ImageToken, we must include the following method.
Type	getType() Return the type of this token.
java.awt.Image	getValue() Return the java.awt.Image object associated with this token.
java.lang.String	toString() Return a description of the token.

Methods inherited from class ptolemy.data.ObjectToken

_isCloseTo, _isEqualTo, convert, equals, getValueClass, hashCode, isCloseTo, isEqualTo, object

Methods inherited from class ptolemy.data.Token

add, addReverse, divide, divideReverse, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AWTImageToken

public AWTImageToken(java.awt.Image value)

Construct a token with a specified java.awt.Image.

Parameters:

value - The given value

Method Detail

asAWTImage

public java.awt.Image asAWTImage()

Because all tokens that contain images must extend ImageToken, we must include the following method.

Specified by:

asAWTImage in class ImageToken

Returns:

The image.

getType

public Type getType()

Description copied from class: ObjectToken

Return the type of this token.

Overrides:

getType in class ObjectToken

Returns:

BaseType.OBJECT

getValue

public java.awt.Image getValue()

Return the java.awt.Image object associated with this token.

Overrides:

getValue in class ObjectToken

Returns:

the java.awt.Image object.

toString

public java.lang.String toString()

Return a description of the token. If possible, derived classes should override this method and 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. Unfortunately, in this base class, we can only return the classname, the width and the height as a string representation of a record.

Overrides:

toString in class ObjectToken

Returns:

The classname, width and height as string representation of a record.