scriptinterface.defaulttypes

Class GCompoundFiles

java.lang.Object

scriptinterface.execution.returnvalues.ExecutionReturn

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

scriptinterface.defaulttypes.GCompoundFiles

All Implemented Interfaces:

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

public class GCompoundFiles
extends ExecutionResult<java.util.LinkedList<GCompoundFile>>
implements IterableAndSize<GCompoundFile>

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
GCompoundFiles()
GCompoundFiles(java.util.LinkedList<GCompoundFile> files)

Method Summary

Modifier and Type	Method and Description
void	addFile(java.io.File file, FileFormat format)
void	addFiles(java.io.File[] files)
boolean	addFiles(java.io.File file, FileFormat format, boolean recursive)
void	addFiles(java.lang.String filename, boolean recursive)
GCompoundFiles	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<GCompoundFile>	getValue() Returns the internal value.
java.util.Iterator<GCompoundFile>	iterator()
void	setValue(java.util.LinkedList<GCompoundFile> 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

GCompoundFiles

public GCompoundFiles(java.util.LinkedList<GCompoundFile> files)

GCompoundFiles

public GCompoundFiles()

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<GCompoundFile>>

Returns:

the type of the result.

clone

public GCompoundFiles clone()

Specified by:

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

getValue

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

Description copied from class: ExecutionResult

Returns the internal value.

Specified by:

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

Returns:

the internal value.

setValue

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

Description copied from class: ExecutionResult

Sets the internal value.

Specified by:

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

Parameters:

value - the new value.

addFile

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

addFiles

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

addFiles

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

addFiles

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<GCompoundFile>

getSize

public int getSize()

Description copied from interface: IterableAndSize

Returns the number of elements to iterate.

Specified by:

getSize in interface IterableAndSize<GCompoundFile>

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<GCompoundFile>>

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()