com.sun.slamd.scripting.general
Class BooleanLiteral

java.lang.Object
  com.sun.slamd.scripting.general.BooleanLiteral

All Implemented Interfaces:

Argument

public class BooleanLiteral
extends java.lang.Object
implements Argument

This class defines a Boolean literal value, which is simply a Boolean value that occurs in a script file without being encapsulated in a variable.

Author:

Neil A. Wilson

Field Summary

static java.lang.String	BOOLEAN_FALSE_VALUE The token that will be used for a Boolean value of "false".
static java.lang.String	BOOLEAN_TRUE_VALUE The token that will be used for a Boolean value of "true".

Constructor Summary

BooleanLiteral(boolean booleanValue)
Creates a new Boolean literal with the specified value.

Method Summary

java.lang.String	getArgumentAsString() Retrieves a string representation of this argument in a form appropriate for inclusion in a script.
java.lang.String	getArgumentType() Retrieves the name of the data type associated with this Boolean literal.
Variable	getArgumentValue() Retrieves the value of this Boolean literal encapsulated in a Boolean variable.
java.lang.String	getValueAsString() Retrieves a string representation of the value of this argument.

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_TRUE_VALUE

public static final java.lang.String BOOLEAN_TRUE_VALUE

The token that will be used for a Boolean value of "true".

See Also:

Constant Field Values

BOOLEAN_FALSE_VALUE

public static final java.lang.String BOOLEAN_FALSE_VALUE

The token that will be used for a Boolean value of "false".

See Also:

Constant Field Values

Constructor Detail

BooleanLiteral

public BooleanLiteral(boolean booleanValue)

Creates a new Boolean literal with the specified value.

Parameters:

booleanValue - The value to use for this Boolean literal.

Method Detail

getArgumentType

public java.lang.String getArgumentType()

Retrieves the name of the data type associated with this Boolean literal.

Specified by:

getArgumentType in interface Argument

Returns:

The name of the data type associated with this Boolean literal.

getArgumentValue

public Variable getArgumentValue()
                          throws ScriptException

Retrieves the value of this Boolean literal encapsulated in a Boolean variable.

Specified by:

getArgumentValue in interface Argument

Returns:

The value of this Boolean literal encapsulated in a Boolean variable.

Throws:

ScriptException - If a problem occurs while determining the value of this Boolean literal.

getArgumentAsString

public java.lang.String getArgumentAsString()

Retrieves a string representation of this argument in a form appropriate for inclusion in a script.

Specified by:

getArgumentAsString in interface Argument

Returns:

A string representation of this argument in a form appropriate for inclusion in a script.

getValueAsString

public java.lang.String getValueAsString()

Retrieves a string representation of the value of this argument.

Specified by:

getValueAsString in interface Argument

Returns:

A string representation of the value of this argument.