lucee.runtime.util

Interface ResourceUtil

public interface ResourceUtil

Field Summary

Fields

Modifier and Type	Field and Description
static char	FILE_ANTI_SEPERATOR Field FILE_ANTI_SEPERATOR
static char	FILE_SEPERATOR Field FILE_SEPERATOR
static short	LEVEL_FILE Field LEVEL_FILE
static short	LEVEL_GRAND_PARENT_FILE Field LEVEL_GRAND_PARENT_FILE
static short	LEVEL_PARENT_FILE Field LEVEL_PARENT_FILE
static short	TYPE_DIR Field TYPE_DIR
static short	TYPE_FILE Field TYPE_FILE

Method Summary

Methods

Modifier and Type	Method and Description
void	checkCopyToOK(Resource source, Resource target) check if copying a file is ok with the rules for the Resource interface, to not change this rules.
void	checkCreateDirectoryOK(Resource resource, boolean createParentWhenNotExists) check if directory creation is ok with the rules for the Resource interface, to not change this rules.
void	checkCreateFileOK(Resource resource, boolean createParentWhenNotExists) check if file creating is ok with the rules for the Resource interface, to not change this rules.
void	checkGetInputStreamOK(Resource resource) check if getting a inputstream of the file is ok with the rules for the Resource interface, to not change this rules.
void	checkGetOutputStreamOK(Resource resource) check if getting a outputstream of the file is ok with the rules for the Resource interface, to not change this rules.
void	checkMoveToOK(Resource source, Resource target) check if moveing a file is ok with the rules for the Resource interface, to not change this rules.
void	checkRemoveOK(Resource resource) check if removing the file is ok with the rules for the Resource interface, to not change this rules.
java.lang.String	contractPath(PageContext pc, java.lang.String path)
void	copyRecursive(Resource src, Resource trg) copy a file or directory recursive (with his content)
void	copyRecursive(Resource src, Resource trg, ResourceFilter filter) copy a file or directory recursive (with his content)
Resource	createResource(Resource res, short level, short type) create a file if possible, return file if ok, otherwise return null
java.lang.String	getExtension(Resource res) Deprecated. use instead getExtension(Resource res, String defaultValue);
java.lang.String	getExtension(Resource res, java.lang.String defaultValue) get the Extension of a file resource
java.lang.String	getExtension(java.lang.String strFile) Deprecated. use instead getExtension(String strFile, String defaultValue);
java.lang.String	getExtension(java.lang.String strFile, java.lang.String defaultValue) get the Extension of a file resource
java.lang.String	getMimeType(byte[] barr, java.lang.String defaultValue) return the mime type of a byte array
java.lang.String	getMimeType(Resource res, java.lang.String defaultValue) return the mime type of a file, does not check the extension of the file, it checks the header
java.lang.String	getPathToChild(Resource file, Resource dir) return diffrents of one file to a other if first is child of second otherwise return null
boolean	isChildOf(Resource file, Resource dir) check if file is a child of given directory
boolean	isEmpty(Resource res) return if Resource is empty, means is directory and has no children or a empty file, if not exist return false.
boolean	isEmptyDirectory(Resource res)
boolean	isEmptyFile(Resource res)
java.lang.String	merge(java.lang.String parent, java.lang.String child)
void	moveTo(Resource src, Resource dest)
void	removeChildren(Resource res)
void	removeChildren(Resource res, ResourceFilter filter)
void	removeChildren(Resource res, ResourceNameFilter filter)
java.lang.String	removeScheme(java.lang.String scheme, java.lang.String path)
void	setAttribute(Resource res, java.lang.String attributes) sets a attribute to the resource
Resource	toResourceExisting(PageContext pc, java.lang.String path) cast a String (argument destination) to a File Object, if destination is not a absolute, file object will be relative to current position (get from PageContext) file must exist otherwise throw exception
Resource	toResourceExistingParent(PageContext pc, java.lang.String destination) cast a String (argument destination) to a File Object, if destination is not a absolute, file object will be relative to current position (get from PageContext) at least parent must exist
Resource	toResourceNotExisting(PageContext pc, java.lang.String destination) cast a String (argument destination) to a File Object, if destination is not a absolute, file object will be relative to current position (get from PageContext) existing file is prefered but dont must exist
java.lang.String	toString(Resource r, java.lang.String charset)
java.lang.String	translatePath(java.lang.String path, boolean slashAdBegin, boolean slashAddEnd)
java.lang.String[]	translatePathName(java.lang.String path)

Field Detail

FILE_SEPERATOR

static final char FILE_SEPERATOR

Field FILE_SEPERATOR

FILE_ANTI_SEPERATOR

static final char FILE_ANTI_SEPERATOR

Field FILE_ANTI_SEPERATOR

TYPE_DIR

static final short TYPE_DIR

Field TYPE_DIR

See Also:

Constant Field Values

TYPE_FILE

static final short TYPE_FILE

Field TYPE_FILE

See Also:

Constant Field Values

LEVEL_FILE

static final short LEVEL_FILE

Field LEVEL_FILE

See Also:

Constant Field Values

LEVEL_PARENT_FILE

static final short LEVEL_PARENT_FILE

Field LEVEL_PARENT_FILE

See Also:

Constant Field Values

LEVEL_GRAND_PARENT_FILE

static final short LEVEL_GRAND_PARENT_FILE

Field LEVEL_GRAND_PARENT_FILE

See Also:

Constant Field Values

Method Detail

toResourceExisting

Resource toResourceExisting(PageContext pc,
                          java.lang.String path)
                            throws PageException

cast a String (argument destination) to a File Object, if destination is not a absolute, file object will be relative to current position (get from PageContext) file must exist otherwise throw exception

Parameters:

pc - Page Context to et actuell position in filesystem

path - relative or absolute path for file object

Returns:

file object from destination

Throws:

ExpressionException

PageException

toResourceExistingParent

Resource toResourceExistingParent(PageContext pc,
                                java.lang.String destination)
                                  throws PageException

cast a String (argument destination) to a File Object, if destination is not a absolute, file object will be relative to current position (get from PageContext) at least parent must exist

Parameters:

pc - Page Context to et actuell position in filesystem

destination - relative or absolute path for file object

Returns:

file object from destination

Throws:

ExpressionException

PageException

toResourceNotExisting

Resource toResourceNotExisting(PageContext pc,
                             java.lang.String destination)

cast a String (argument destination) to a File Object, if destination is not a absolute, file object will be relative to current position (get from PageContext) existing file is prefered but dont must exist

Parameters:

pc - Page Context to et actuell position in filesystem

destination - relative or absolute path for file object

Returns:

file object from destination

createResource

Resource createResource(Resource res,
                      short level,
                      short type)

create a file if possible, return file if ok, otherwise return null

Parameters:

res - file to touch

level - touch also parent and grand parent

type - is file or directory

Returns:

file if exists, otherwise null

setAttribute

void setAttribute(Resource res,
                java.lang.String attributes)
                  throws java.io.IOException

sets a attribute to the resource

Parameters:

res -

attributes -

Throws:

java.io.IOException

getMimeType

java.lang.String getMimeType(Resource res,
                           java.lang.String defaultValue)

return the mime type of a file, does not check the extension of the file, it checks the header

Parameters:

res -

defaultValue -

Returns:

mime type of the file

getMimeType

java.lang.String getMimeType(byte[] barr,
                           java.lang.String defaultValue)

return the mime type of a byte array

Parameters:

barr -

defaultValue -

Returns:

mime type of the file

isChildOf

boolean isChildOf(Resource file,
                Resource dir)

check if file is a child of given directory

Parameters:

file - file to search

dir - directory to search

Returns:

is inside or not

getPathToChild

java.lang.String getPathToChild(Resource file,
                              Resource dir)

return diffrents of one file to a other if first is child of second otherwise return null

Parameters:

file - file to search

dir - directory to search

getExtension

java.lang.String getExtension(Resource res)

Deprecated. use instead getExtension(Resource res, String defaultValue);

get the Extension of a file resource

Parameters:

res -

Returns:

extension of file

getExtension

java.lang.String getExtension(Resource res,
                            java.lang.String defaultValue)

get the Extension of a file resource

Parameters:

res -

Returns:

extension of file

getExtension

java.lang.String getExtension(java.lang.String strFile)

Deprecated. use instead getExtension(String strFile, String defaultValue);

get the Extension of a file

Parameters:

strFile -

Returns:

extension of file

getExtension

java.lang.String getExtension(java.lang.String strFile,
                            java.lang.String defaultValue)

get the Extension of a file resource

Parameters:

res -

Returns:

extension of file

copyRecursive

void copyRecursive(Resource src,
                 Resource trg)
                   throws java.io.IOException

copy a file or directory recursive (with his content)

Parameters:

file - file or directory to delete

Throws:

java.io.IOException

java.io.FileNotFoundException

copyRecursive

void copyRecursive(Resource src,
                 Resource trg,
                 ResourceFilter filter)
                   throws java.io.IOException

copy a file or directory recursive (with his content)

Parameters:

src -

trg -

filter -

Throws:

java.io.IOException

java.io.FileNotFoundException

removeChildren

void removeChildren(Resource res)
                    throws java.io.IOException

Throws:

java.io.IOException

removeChildren

void removeChildren(Resource res,
                  ResourceNameFilter filter)
                    throws java.io.IOException

Throws:

java.io.IOException

removeChildren

void removeChildren(Resource res,
                  ResourceFilter filter)
                    throws java.io.IOException

Throws:

java.io.IOException

moveTo

void moveTo(Resource src,
          Resource dest)
            throws java.io.IOException

Throws:

java.io.IOException

isEmpty

boolean isEmpty(Resource res)

return if Resource is empty, means is directory and has no children or a empty file, if not exist return false.

Parameters:

res -

isEmptyDirectory

boolean isEmptyDirectory(Resource res)

isEmptyFile

boolean isEmptyFile(Resource res)

translatePath

java.lang.String translatePath(java.lang.String path,
                             boolean slashAdBegin,
                             boolean slashAddEnd)

translatePathName

java.lang.String[] translatePathName(java.lang.String path)

merge

java.lang.String merge(java.lang.String parent,
                     java.lang.String child)

removeScheme

java.lang.String removeScheme(java.lang.String scheme,
                            java.lang.String path)

checkCreateDirectoryOK

void checkCreateDirectoryOK(Resource resource,
                          boolean createParentWhenNotExists)
                            throws java.io.IOException

check if directory creation is ok with the rules for the Resource interface, to not change this rules.

Parameters:

resource -

createParentWhenNotExists -

Throws:

java.io.IOException

checkCreateFileOK

void checkCreateFileOK(Resource resource,
                     boolean createParentWhenNotExists)
                       throws java.io.IOException

check if file creating is ok with the rules for the Resource interface, to not change this rules.

Parameters:

resource -

createParentWhenNotExists -

Throws:

java.io.IOException

checkCopyToOK

void checkCopyToOK(Resource source,
                 Resource target)
                   throws java.io.IOException

check if copying a file is ok with the rules for the Resource interface, to not change this rules.

Parameters:

source -

target -

Throws:

java.io.IOException

checkMoveToOK

void checkMoveToOK(Resource source,
                 Resource target)
                   throws java.io.IOException

check if moveing a file is ok with the rules for the Resource interface, to not change this rules.

Parameters:

source -

target -

Throws:

java.io.IOException

checkGetInputStreamOK

void checkGetInputStreamOK(Resource resource)
                           throws java.io.IOException

check if getting a inputstream of the file is ok with the rules for the Resource interface, to not change this rules.

Parameters:

resource -

Throws:

java.io.IOException

checkGetOutputStreamOK

void checkGetOutputStreamOK(Resource resource)
                            throws java.io.IOException

check if getting a outputstream of the file is ok with the rules for the Resource interface, to not change this rules.

Parameters:

resource -

Throws:

java.io.IOException

checkRemoveOK

void checkRemoveOK(Resource resource)
                   throws java.io.IOException

check if removing the file is ok with the rules for the Resource interface, to not change this rules.

Parameters:

resource -

Throws:

java.io.IOException

toString

java.lang.String toString(Resource r,
                        java.lang.String charset)
                          throws java.io.IOException

Throws:

java.io.IOException

contractPath

java.lang.String contractPath(PageContext pc,
                            java.lang.String path)