scriptinterface.defaulttypes

Class GFile

java.lang.Object

scriptinterface.execution.returnvalues.ExecutionReturn

scriptinterface.execution.returnvalues.ExecutionResult<java.io.File>

scriptinterface.defaulttypes.GFile

All Implemented Interfaces:

TextHolder

Direct Known Subclasses:

GExistingFile

public class GFile
extends ExecutionResult<java.io.File>
implements TextHolder

Script type wrapper for File.

Field Summary

Fields

Modifier and Type	Field and Description
protected FileFormat	format
protected java.io.File	value

Fields inherited from class scriptinterface.execution.returnvalues.ExecutionReturn

QUIT, UNDEF, VOID

Constructor Summary

Constructors

Constructor and Description
GFile()
GFile(java.io.File value)
GFile(java.io.File value, FileFormat format)

Method Summary

Modifier and Type	Method and Description
GFile	clone()
FileFormat	getFormat()
java.lang.String	getScriptConstantRepresentation() Returns the value as a constant in valid script syntax.
java.lang.String	getStringRepresentation() Returns a user-readable string representation of this instance.
java.lang.String	getText() Returns the text.
ScriptType	getType() Returns the type of the result.
java.io.File	getValue() Returns the internal value.
void	setFormat(FileFormat format)
void	setValue(java.io.File value) Sets the internal value.

Methods inherited from class scriptinterface.execution.returnvalues.ExecutionResult

equals, getSign, getTypeName, isZero, toString, valueToString

Methods inherited from class scriptinterface.execution.returnvalues.ExecutionReturn

isStopExecution

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

protected java.io.File value

format

protected FileFormat format

Constructor Detail

GFile

public GFile(java.io.File value)

GFile

public GFile(java.io.File value,
             FileFormat format)

GFile

public GFile()

Method Detail

getValue

public java.io.File getValue()

Description copied from class: ExecutionResult

Returns the internal value.

Specified by:

getValue in class ExecutionResult<java.io.File>

Returns:

the internal value.

setValue

public void setValue(java.io.File value)

Description copied from class: ExecutionResult

Sets the internal value.

Specified by:

setValue in class ExecutionResult<java.io.File>

Parameters:

value - the new value.

getFormat

public FileFormat getFormat()

setFormat

public void setFormat(FileFormat format)

getType

public ScriptType getType()

Description copied from class: ExecutionResult

Returns the type of the result.

Specified by:

getType in class ExecutionResult<java.io.File>

Returns:

the type of the result.

clone

public GFile clone()

Specified by:

clone in class ExecutionResult<java.io.File>

getText

public java.lang.String getText()

Description copied from interface: TextHolder

Returns the text.

Specified by:

getText in interface TextHolder

Returns:

the text.

getStringRepresentation

public java.lang.String getStringRepresentation()

Description copied from class: ExecutionReturn

Returns a user-readable string representation of this instance.

Overrides:

getStringRepresentation in class ExecutionResult<java.io.File>

Returns:

the string representation of this instance.

getScriptConstantRepresentation

public java.lang.String getScriptConstantRepresentation()

Description copied from class: ExecutionReturn

Returns the value as a constant in valid script syntax.

Overrides:

getScriptConstantRepresentation in class ExecutionReturn

Returns:

the value in its constant representation.