org.millscript.millscript.functions
Class AbstractOutputFunction

java.lang.Object
  org.millscript.millscript.functions.Function
      org.millscript.millscript.functions.AbstractOutputFunction

Direct Known Subclasses:

AbstractOutputFileFunction, CopyToOutputFunction, MakeFolderFunction, RelativeFunction

public abstract class AbstractOutputFunction
extends Function

This class provides the basic methods required for a function generating output. These methods are geared towards obtaining and creating directories in the script output and determining the current working directory.

Field Summary

protected Configuration

config The configuration to use for this function.

Constructor Summary

protected

AbstractOutputFunction(Package pack) Constructs a new abstract output function for the specified package.

Method Summary

org.millscript.commons.vfs.VFolder	getCurrentWorkingFolder() Returns a VFolder for the current working output folder, based on the value of the folder variable.
org.millscript.commons.util.IList	getCurrentWorkingFolderList() Returns the current working folder list.
org.millscript.commons.vfs.VFolder	getWorkingFolder(org.millscript.commons.util.IList folderList) Returns a VFolder for the specified current working output folder list.
org.millscript.commons.vfs.VFolder	makeCurrentWorkingFolder() Makes the current working folder, returning a VFolder for the made folder.

Methods inherited from class org.millscript.millscript.functions.Function

apply, applyUpdater, checkNargs, checkNargsGT, checkUNargs, getName, modName, reportNargsError, reportNargsGTError, setName, toString, tryClone

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final Configuration config

The configuration to use for this function.

Constructor Detail

AbstractOutputFunction

protected AbstractOutputFunction(Package pack)

Constructs a new abstract output function for the specified package.

Parameters:

pack - the package this output function is defined in

Method Detail

getCurrentWorkingFolder

public final org.millscript.commons.vfs.VFolder getCurrentWorkingFolder()

Returns a VFolder for the current working output folder, based on the value of the folder variable.

Returns:

a VFolder for the current working output folder

getCurrentWorkingFolderList

public final org.millscript.commons.util.IList getCurrentWorkingFolderList()

Returns the current working folder list.

Returns:

a List representing the current working folder

getWorkingFolder

public final org.millscript.commons.vfs.VFolder getWorkingFolder(org.millscript.commons.util.IList folderList)

Returns a VFolder for the specified current working output folder list.

Parameters:

folderList - a List specifying the current working folder

Returns:

a VFolder for the specified current working folder

makeCurrentWorkingFolder

public final org.millscript.commons.vfs.VFolder makeCurrentWorkingFolder()

Makes the current working folder, returning a VFolder for the made folder.

Returns:

a VFolder for the folder that's just been made