scriptinterface.defaulttypes

Class GFiles

java.lang.Object

scriptinterface.execution.returnvalues.ExecutionReturn

scriptinterface.execution.returnvalues.ExecutionResult<java.util.LinkedList<GFile>>

scriptinterface.defaulttypes.GFiles

All Implemented Interfaces:

java.lang.Iterable<GFile>, IterableAndSize<GFile>

public class GFiles
extends ExecutionResult<java.util.LinkedList<GFile>>
implements IterableAndSize<GFile>

Script type wrapper for files. The file is assumed to exist.

Field Summary

Fields inherited from class scriptinterface.execution.returnvalues.ExecutionReturn

QUIT, UNDEF, VOID

Constructor Summary

Constructors

Constructor and Description
GFiles()
GFiles(java.util.LinkedList<GFile> files)

Method Summary

Modifier and Type	Method and Description
void	addFile(java.io.File file)
void	addFile(java.io.File file, FileFormat format)
void	addFiles(java.io.File[] files)
boolean	addFiles(java.io.File file, boolean recursive)
void	addFiles(java.lang.String filename, boolean recursive)
GFiles	clone()
java.lang.String	getScriptConstantRepresentation() Returns the value as a constant in valid script syntax.
int	getSize() Returns the number of elements to iterate.
java.lang.String	getStringRepresentation() Returns a user-readable string representation of this instance.
ScriptType	getType() Returns the type of the result.
java.util.LinkedList<GFile>	getValue() Returns the internal value.
java.util.Iterator<GFile>	iterator()
void	setValue(java.util.LinkedList<GFile> value) Sets the internal value.
java.io.File[]	toArray()

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GFiles

public GFiles(java.util.LinkedList<GFile> files)

GFiles

public GFiles()

Method Detail

getType

public ScriptType getType()

Description copied from class: ExecutionResult

Returns the type of the result.

Specified by:

getType in class ExecutionResult<java.util.LinkedList<GFile>>

Returns:

the type of the result.

clone

public GFiles clone()

Specified by:

clone in class ExecutionResult<java.util.LinkedList<GFile>>

getValue

public java.util.LinkedList<GFile> getValue()

Description copied from class: ExecutionResult

Returns the internal value.

Specified by:

getValue in class ExecutionResult<java.util.LinkedList<GFile>>

Returns:

the internal value.

setValue

public void setValue(java.util.LinkedList<GFile> value)

Description copied from class: ExecutionResult

Sets the internal value.

Specified by:

setValue in class ExecutionResult<java.util.LinkedList<GFile>>

Parameters:

value - the new value.

addFile

public void addFile(java.io.File file,
                    FileFormat format)

addFile

public void addFile(java.io.File file)

addFiles

public void addFiles(java.io.File[] files)

addFiles

public boolean addFiles(java.io.File file,
                        boolean recursive)

addFiles

public void addFiles(java.lang.String filename,
                     boolean recursive)

iterator

public java.util.Iterator<GFile> iterator()

Specified by:

iterator in interface java.lang.Iterable<GFile>

getSize

public int getSize()

Description copied from interface: IterableAndSize

Returns the number of elements to iterate.

Specified by:

getSize in interface IterableAndSize<GFile>

Returns:

the number of elements to iterate.

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.util.LinkedList<GFile>>

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.

toArray

public java.io.File[] toArray()