com.brightech.mb.workflow.js

Class UnmanagedFolder

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.UnmanagedFolder

All Implemented Interfaces:

IFolderObject, java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class UnmanagedFolder
extends JSBaseScriptableObject
implements IFolderObject

The class is for overwriting File's method that aren't applicable for folders that are out of MBAssets.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
UnmanagedFolder()

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String thePathName) Construct a unmanaged folder reference to a folder that may or may not exist.
boolean	(JavaScript Function) create() Creates this folder and all parent folders
FileAndFolderIterator	(JavaScript Function) getContents(int theDepth) Gets all files and folders in the folder.
boolean	(JavaScript Getter) exists() Tests whether the directory denoted by this abstract pathname exists.
java.lang.String	(JavaScript Getter) name() Returns the name of the directory.
IFolderObject	(JavaScript Getter) parent() Returns the parent directory.
java.lang.String	(JavaScript Getter) path() Get the folder's absolute path.

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

UnmanagedFolder

public UnmanagedFolder()

Method Detail

jsConstructor

public void jsConstructor(java.lang.String thePathName)
                   throws java.io.IOException

Construct a unmanaged folder reference to a folder that may or may not exist. This path can be either absolute or relative to the MediaBeacon asset root folder.

Parameters:

thePathName - the absolute or relative path to the folder.

Throws:

java.io.IOException

(JavaScript Getter) path

public java.lang.String (JavaScript Getter) path()

Get the folder's absolute path. The path will use file separators as appropriate for the file system in use (windows or unix).

Specified by:

(JavaScript Getter) path in interface IFolderObject

Returns:

The folder's absolute path. The path will use file separators as appropriate for the file system in use (windows or unix).

(JavaScript Getter) exists

public boolean (JavaScript Getter) exists()

Tests whether the directory denoted by this abstract pathname exists.

Specified by:

(JavaScript Getter) exists in interface IFolderObject

Returns:

true if the file or directory exists.

(JavaScript Getter) name

public java.lang.String (JavaScript Getter) name()

Returns the name of the directory.

Specified by:

(JavaScript Getter) name in interface IFolderObject

Returns:

returns the name of the file or directory.

(JavaScript Getter) parent

public IFolderObject (JavaScript Getter) parent()

Returns the parent directory.

Specified by:

(JavaScript Getter) parent in interface IFolderObject

Returns:

the IFileObject represents parent file or directory.

(JavaScript Function) getContents

public FileAndFolderIterator (JavaScript Function) getContents(int theDepth)

Gets all files and folders in the folder.

Parameters:

theDepth - the depth of the recursion, if it is not specified or null then the method returns all files and folders at any depth.

Returns:

the files iterator.

(JavaScript Function) create

public boolean (JavaScript Function) create()

Creates this folder and all parent folders

Returns:

true if and only if the directory was created, along with all necessary parent directories; false otherwise