org.millscript.millscript.conf
Class WebsiteConf

java.lang.Object
  org.millscript.millscript.conf.AbstractConfiguration
      org.millscript.millscript.conf.WebsiteConf

All Implemented Interfaces:

Configuration

public class WebsiteConf
extends AbstractConfiguration

This class is the basis of a website configuration.

Field Summary

Fields inherited from class org.millscript.millscript.conf.AbstractConfiguration

cwd, htmlCharacterEntities, loaderBuilder, logger, outputCharset, properties, vfs, xmlCharacterEntities

Fields inherited from interface org.millscript.millscript.conf.Configuration

CACHE_NAME, CONF_NAME, DOT_WEBSITE_NAME, INVENTORY_NAME, LIB_NAME, OUTPUT_NAME, PACKAGE_CONF_FILE, USER_CONF_FILE, VAR_NAME, WEBSITE_CONF_FILE, WEBSITE_FAILURE_FILE, WEBSITE_LOCK_FILE, WEBSITE_SUCCESSS_FILE

Constructor Summary

WebsiteConf()

Method Summary

java.lang.String	getInteractivePrompt() Returns the prompt MillScript should use during a session.
org.millscript.commons.vfs.VFolder	getStandardConfFolder() Returns the location of the standard configuration folder.
org.millscript.commons.vfs.VFile	getStandardConfigurationFile() Returns the location of the user configuration file.
Engine	getStandardEngine() Returns the standard engine for this configuration.
org.millscript.commons.vfs.VFolder	getStandardInventoryFolder() Returns the location of the standard inventory.
org.millscript.commons.vfs.VFolder	getStandardLibFolder() Returns the location of the standard library folder.
Package	getStandardPackage(Engine engine) Returns the standard package for this configuration.
org.millscript.commons.vfs.VFolder	getWebsiteCacheFolder() Returns the location of the websites cache folder.
org.millscript.commons.vfs.VFolder	getWebsiteConfFolder() Returns the location of the websites configuration folder.
org.millscript.commons.vfs.VFile	getWebsiteConfigurationFile() Returns the location of the website configuration file.
org.millscript.commons.vfs.VFile	getWebsiteFailureFile() Returns the location of the website lock file.
org.millscript.commons.vfs.VFolder	getWebsiteInventoryFolder() Returns the location of the websites inventory.
org.millscript.commons.vfs.VFolder	getWebsiteLibFolder() Returns the location of the websites library folder.
org.millscript.commons.vfs.VFile	getWebsiteLockFile() Returns the location of the website lock file.
org.millscript.commons.vfs.VFolder	getWebsiteOutputFolder() Returns the location of the websites output folder.
org.millscript.commons.vfs.VFile	getWebsiteSuccessFile() Returns the location of the website success file.
org.millscript.commons.vfs.VFolder	getWebsiteVarFolder() Returns the location of the websites var folder.

Methods inherited from class org.millscript.millscript.conf.AbstractConfiguration

getBooleanProperty, getCurrentWorkingFolder, getHTMLCharacterEntity, getLoaderBuilder, getLogger, getOutputCharset, getPackageConfFile, getProperty, getVFS, getXMLCharacterEntity, reportAlertAsMishap, reportAlertAsWarning, reportException, setLogger, setOutputCharset, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

WebsiteConf

public WebsiteConf()

Method Detail

getInteractivePrompt

public java.lang.String getInteractivePrompt()

Description copied from interface: Configuration

Returns the prompt MillScript should use during a session. This should be null for an batch session and whatever string the user desires for an interactive session.

Returns:

a String containing the interactive prompt

See Also:

Configuration.getInteractivePrompt()

getStandardConfFolder

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

Description copied from interface: Configuration

Returns the location of the standard configuration folder.

Returns:

a VFolder object pointing to the standard configuration folder.

See Also:

Configuration.getStandardConfFolder()

getStandardConfigurationFile

public org.millscript.commons.vfs.VFile getStandardConfigurationFile()

Description copied from interface: Configuration

Returns the location of the user configuration file.

Returns:

a VFile object pointing to the user configuration file.

See Also:

Configuration.getStandardConfigurationFile()

getStandardEngine

public Engine getStandardEngine()

Description copied from interface: Configuration

Returns the standard engine for this configuration. The standard engine may contain a number of builtin packages, e.g. the "standard" Package.

Specified by:

getStandardEngine in interface Configuration

Overrides:

getStandardEngine in class AbstractConfiguration

Returns:

the standard Engine for this configuration

See Also:

Configuration.getStandardEngine()

getStandardInventoryFolder

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

Description copied from interface: Configuration

Returns the location of the standard inventory.

Returns:

a VFolder object pointing to the standard inventory folder.

See Also:

Configuration.getStandardInventoryFolder()

getStandardLibFolder

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

Description copied from interface: Configuration

Returns the location of the standard library folder.

Returns:

a VFolder object pointing to the standard library folder.

See Also:

Configuration.getStandardLibFolder()

getStandardPackage

public Package getStandardPackage(Engine engine)

Description copied from interface: Configuration

Returns the standard package for this configuration. This includes all the builtin variables and functions that are appropriate.

Specified by:

getStandardPackage in interface Configuration

Overrides:

getStandardPackage in class AbstractConfiguration

Parameters:

engine - the engine this package is associated with

Returns:

the standard Package for this configuration

See Also:

Configuration.getStandardPackage(org.millscript.millscript.vm.Engine)

getWebsiteCacheFolder

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

Description copied from interface: Configuration

Returns the location of the websites cache folder.

Returns:

a VFolder object pointing to the websites cache folder.

See Also:

Configuration.getWebsiteCacheFolder()

getWebsiteConfFolder

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

Description copied from interface: Configuration

Returns the location of the websites configuration folder.

Returns:

a VFolder object pointing to the websites configuration folder.

See Also:

Configuration.getWebsiteConfFolder()

getWebsiteConfigurationFile

public org.millscript.commons.vfs.VFile getWebsiteConfigurationFile()

Description copied from interface: Configuration

Returns the location of the website configuration file.

Returns:

a VFile object pointing to the website configuration file.

See Also:

Configuration.getWebsiteConfigurationFile()

getWebsiteFailureFile

public org.millscript.commons.vfs.VFile getWebsiteFailureFile()

Description copied from interface: Configuration

Returns the location of the website lock file.

Returns:

a VFile object pointing to the website lock file.

See Also:

Configuration.getWebsiteFailureFile()

getWebsiteInventoryFolder

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

Description copied from interface: Configuration

Returns the location of the websites inventory. This is the inventory associated with the website script.

Returns:

a VFolder object pointing to the websites inventory folder.

See Also:

Configuration.getWebsiteInventoryFolder()

getWebsiteLibFolder

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

Description copied from interface: Configuration

Returns the location of the websites library folder.

Returns:

a VFolder object pointing to the websites library folder.

See Also:

Configuration.getWebsiteLibFolder()

getWebsiteOutputFolder

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

Description copied from interface: Configuration

Returns the location of the websites output folder.

Returns:

a VFolder object pointing to the websites output folder.

See Also:

Configuration.getWebsiteOutputFolder()

getWebsiteLockFile

public org.millscript.commons.vfs.VFile getWebsiteLockFile()

Description copied from interface: Configuration

Returns the location of the website lock file.

Returns:

a VFile object pointing to the website lock file.

See Also:

Configuration.getWebsiteLockFile()

getWebsiteSuccessFile

public org.millscript.commons.vfs.VFile getWebsiteSuccessFile()

Description copied from interface: Configuration

Returns the location of the website success file.

Returns:

a VFile object pointing to the website success file.

See Also:

Configuration.getWebsiteSuccessFile()

getWebsiteVarFolder

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

Description copied from interface: Configuration

Returns the location of the websites var folder.

Returns:

a VFolder object pointing to the websites var folder.

See Also:

Configuration.getWebsiteVarFolder()