net.sf.mmm.util.file.base

Class FileUtilImpl

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.file.base.FileUtilLimitedImpl

net.sf.mmm.util.file.base.FileUtilImpl

All Implemented Interfaces:

FileUtil, FileUtilLimited

public class FileUtilImpl
extends FileUtilLimitedImpl
implements FileUtil

This class is a collection of utility functions for File handling and manipulation.

Since:

1.0.1

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

getInstance()

Field Summary

Fields

Modifier and Type	Field and Description
private static FileUtil	instance
private StringUtil	stringUtil
private File	temporaryDirectory
private String	temporaryDirectoryPath
private File	userHomeDirectory
private String	userHomeDirectoryPath
private String	userLogin

Fields inherited from class net.sf.mmm.util.file.base.FileUtilLimitedImpl

HOME_ROOT

Fields inherited from interface net.sf.mmm.util.file.api.FileUtilLimited

NO_FILES, PATH_SEGMENT_CURRENT, PATH_SEGMENT_PARENT, PROPERTY_TMP_DIR, PROPERTY_USER_HOME

Constructor Summary

Constructors

Constructor and Description
FileUtilImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
private void	collectMatchingFiles(File cwd, List<ResourcePathNode<Pattern>> segments, int segmentIndex, FileType fileType, List<File> list) This method adds all files matching with the given path and fileType to the list.
boolean	collectMatchingFiles(File cwd, String path, FileType fileType, List<File> list) This method adds all files matching the given path and fileType to the list.
void	copyFile(File source, File destination) This method copies the file given by source to the file given by destination.
void	copyFile(File source, File destination, boolean keepFlags) This method copies the file given by source to the file given by destination.
void	copyRecursive(File source, File destination, boolean allowOverwrite) This method copies the file or directory given by source into the given destination.
void	copyRecursive(File source, File destination, boolean allowOverwrite, FileFilter filter) This method copies the file or directory given by source into the given destination.
private void	copyRecursive(File source, File destination, FileFilter filter) This method copies the file or directory given by source into the given destination.
int	deleteChildren(File directory) This method deletes all children of the given directory recursively.
int	deleteRecursive(File path) This method deletes the given path.
protected void	doInitialize() This method performs the actual initialization.
static FileUtil	getInstance() This method gets the singleton instance of this FileUtilImpl.
File[]	getMatchingFiles(File cwd, String path, FileType fileType) This method gets all files matching to the given path and fileType .
FileAccessPermissions	getPermissions(File file, FileAccessClass accessClass) This method gets the permissions of the given file.
protected StringUtil	getStringUtil() This method gets the StringUtilImpl that is used by this FileUtilImpl.
File	getTemporaryDirectory() This method gets the File representing the temporary directory.
File	getUserHomeDirectory() This method gets the File representing the home directory of the current user.
protected String	getUserHomeDirectoryPath()
String	getUserLogin()
void	setPermissions(File file, FileAccessPermissions permissions) This method sets the permissions of the given file.
void	setStringUtil(StringUtil stringUtil) This method sets the StringUtil.
void	setTemporaryDirectoryPath(String tmpDir) This method sets the tmp directory.
void	setUserHomeDirectoryPath(String userHome) This method set the users home directory.
void	setUserLogin(String userLogin)

Methods inherited from class net.sf.mmm.util.file.base.FileUtilLimitedImpl

getBasename, getDirname, getExtension, normalizeHome, normalizePath, normalizePath

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.file.api.FileUtilLimited

getBasename, getDirname, getExtension, normalizePath, normalizePath

Field Detail

instance

private static FileUtil instance

stringUtil

private StringUtil stringUtil

userHomeDirectoryPath

private String userHomeDirectoryPath

userHomeDirectory

private File userHomeDirectory

userLogin

private String userLogin

temporaryDirectoryPath

private String temporaryDirectoryPath

temporaryDirectory

private File temporaryDirectory

Constructor Detail

FileUtilImpl

public FileUtilImpl()

The constructor.

Method Detail

getInstance

public static FileUtil getInstance()

This method gets the singleton instance of this FileUtilImpl.
ATTENTION:
Please read Cdi.GET_INSTANCE before using.

Returns:

the singleton instance.

doInitialize

protected void doInitialize()

Description copied from class: AbstractComponent

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

getStringUtil

protected StringUtil getStringUtil()

This method gets the StringUtilImpl that is used by this FileUtilImpl.

Returns:

the stringUtil the StringUtilImpl.

setStringUtil

@Inject
public void setStringUtil(StringUtil stringUtil)
                            throws AlreadyInitializedException

This method sets the StringUtil. It can only be set once during initialization.

Parameters:

stringUtil - the stringUtil to set.

Throws:

AlreadyInitializedException - if the value has already been set.

getUserHomeDirectory

public File getUserHomeDirectory()

Description copied from interface: FileUtil

This method gets the File representing the home directory of the current user.

Specified by:

getUserHomeDirectory in interface FileUtil

Returns:

the home directory of the user.

getUserHomeDirectoryPath

protected String getUserHomeDirectoryPath()

Overrides:

getUserHomeDirectoryPath in class FileUtilLimitedImpl

Returns:

the path to the home directory of the current user.

setUserHomeDirectoryPath

public void setUserHomeDirectoryPath(String userHome)
                              throws AlreadyInitializedException

This method set the users home directory. It can only be set during initialization.

Parameters:

userHome - is the home directory of the user.

Throws:

AlreadyInitializedException - if the value has already been set.

getTemporaryDirectory

public File getTemporaryDirectory()

Description copied from interface: FileUtil

This method gets the File representing the temporary directory.

Specified by:

getTemporaryDirectory in interface FileUtil

Returns:

the tmp directory.

setTemporaryDirectoryPath

public void setTemporaryDirectoryPath(String tmpDir)
                               throws AlreadyInitializedException

This method sets the tmp directory.

Parameters:

tmpDir - the tmpDir to set

Throws:

AlreadyInitializedException - if the value has already been set.

getUserLogin

public String getUserLogin()

Overrides:

getUserLogin in class FileUtilLimitedImpl

Returns:

the login of the current user (from system property "user.name").

setUserLogin

public void setUserLogin(String userLogin)

Parameters:

userLogin - is the userLogin to set

copyFile

public void copyFile(File source,
                     File destination)

Description copied from interface: FileUtil

This method copies the file given by source to the file given by destination.

Specified by:

copyFile in interface FileUtil

Parameters:

source - is the existing file to copy from.

destination - is the file to copy to. It will be created if it does NOT exist and overridden otherwise.

copyFile

public void copyFile(File source,
                     File destination,
                     boolean keepFlags)

Description copied from interface: FileUtil

This method copies the file given by source to the file given by destination.
ATTENTION:
This method will only work with java 1.6 and above!

Specified by:

copyFile in interface FileUtil

Parameters:

source - is the existing file to copy from.

destination - is the file to copy to. It will be created if it does NOT exist and overridden otherwise.

keepFlags - - true if the flags of the file should be copied as well, false otherwise (a new file is created with default flags and only the content is copied).

copyRecursive

public void copyRecursive(File source,
                          File destination,
                          boolean allowOverwrite)

Description copied from interface: FileUtil

This method copies the file or directory given by source into the given destination.
ATTENTION:
In order to allow giving the copy of source a new name, the destination has to point to the final place where the copy should appear rather than the directory where the copy will be located in.

E.g. the following code copies the folder "foo" located in "/usr/local" recursively to the directory "/tmp". The copy will have the same name "foo".

 File source = new File("/usr/local/foo");
 File destination = new File("/tmp", source.getName()); // file: "/tmp/foo"
 fileUtil.copyRecursive(source, destination, true);
 

Specified by:

copyRecursive in interface FileUtil

Parameters:

source - is the file or directory to copy.

destination - is the final place where the copy should appear.

allowOverwrite - - if false and the destination already exists, a RuntimeIoException is thrown, else if true the destination will be overwritten.

copyRecursive

public void copyRecursive(File source,
                          File destination,
                          boolean allowOverwrite,
                          FileFilter filter)

Description copied from interface: FileUtil

This method copies the file or directory given by source into the given destination.
ATTENTION:
In order to allow giving the copy of source a new name, the destination has to point to the final place where the copy should appear rather than the directory where the copy will be located in.

Specified by:

copyRecursive in interface FileUtil

Parameters:

source - is the file or directory to copy.

destination - is the final place where the copy should appear.

allowOverwrite - - if false and the destination already exists, a RuntimeIoException is thrown, else if true the destination will be overwritten.

filter - is a FileFilter that decides which files should be copied. Only accepted files and directories are copied, others will be ignored.

See Also:

FileUtil.copyRecursive(File, File, boolean)

copyRecursive

private void copyRecursive(File source,
                           File destination,
                           FileFilter filter)

This method copies the file or directory given by source into the given destination.
ATTENTION:
In order to allow giving the copy of source a new name, the destination has to point to the final place where the copy should appear rather than the directory where the copy will be located in.

E.g. the following code copies the folder "foo" located in "/usr/local" recursively to the directory "/tmp". The copy will have the same name "foo".

 File source = new File("/usr/local/foo");
 File destination = new File("/tmp", source.getName()); // file: "/tmp/foo"
 FileUtilImpl.copyRecursive(source, destination, true);
 

Parameters:

source - is the file or directory to copy.

destination - is the final place where the copy should appear.

filter - is a FileFilter that decides which files should be copied. Only accepted files and directories are copied, others will be ignored.

getPermissions

public FileAccessPermissions getPermissions(File file,
                                            FileAccessClass accessClass)

Description copied from interface: FileUtil

This method gets the permissions of the given file.
ATTENTION:
This operation is only available since java 6. Further it is limited and can only determine the permissions granted to the current user running this application.

Specified by:

getPermissions in interface FileUtil

Parameters:

file - is the file for which the permissions are requested.

accessClass - is the distinct class the permission should be applied to in the returned permissions. It may be null to apply the permissions to all distinct classes.

Returns:

the permissions of file.

setPermissions

public void setPermissions(File file,
                           FileAccessPermissions permissions)

Description copied from interface: FileUtil

This method sets the permissions of the given file.
ATTENTION:
This operation is only available since java 6. Further it is limited to the permissions FileAccessClass.OTHERS and FileAccessClass.USER so FileAccessClass.GROUP flags are ignored as well as the global s-bits (sticky, setgid and setuid).

Specified by:

setPermissions in interface FileUtil

Parameters:

file - is the file to modify.

permissions - are the permissions to set.

deleteRecursive

public int deleteRecursive(File path)

Description copied from interface: FileUtil

This method deletes the given path. If the path denotes a directory then it will be deleted recursively.

Specified by:

deleteRecursive in interface FileUtil

Parameters:

path - is the path to delete.

Returns:

the number of files that have been deleted (excluding the directories).

See Also:

FileUtil.deleteChildren(File)

deleteChildren

public int deleteChildren(File directory)

Description copied from interface: FileUtil

This method deletes all children of the given directory recursively. If the given directory denotes an existing directory then it will be empty after the call of this method, else this method will have no effect.

Specified by:

deleteChildren in interface FileUtil

Parameters:

directory - is the directory to delete.

Returns:

the number of files that have been deleted (excluding the directories).

getMatchingFiles

public File[] getMatchingFiles(File cwd,
                               String path,
                               FileType fileType)

Description copied from interface: FileUtil

This method gets all files matching to the given path and fileType . The path may contain wildcards.
Examples:

• getMatchingFiles(cwd, "*", FileType.DIRECTORY) will return all directories in cwd
• getMatchingFiles(cwd, "*/*.xml", FileType.FILE) will return all files from all direct sub-folders of cwd that end with ".xml"
• getMatchingFiles(cwd, "**/*.xml", FileType.FILE) will return all files in cwd or any of its transitive sub-folders that end with ".xml"

Specified by:

getMatchingFiles in interface FileUtil

Parameters:

cwd - is the current working directory and should therefore point to an existing directory. If the given path is NOT absolute it is interpreted relative to this directory.

path - is the path the requested files must match. If this path is NOT absolute it is interpreted relative to the directory given by cwd.

fileType - is the type of the requested files or null if files of any type are acceptable.

Returns:

an array containing all the files that match the given path and apply to ignore

See Also:

FileUtil.collectMatchingFiles(File, String, FileType, List)

collectMatchingFiles

public boolean collectMatchingFiles(File cwd,
                                    String path,
                                    FileType fileType,
                                    List<File> list)

Description copied from interface: FileUtil

This method adds all files matching the given path and fileType to the list. The path may contain wildcards.

Specified by:

collectMatchingFiles in interface FileUtil

Parameters:

cwd - is the current working directory and should therefore point to an existing directory. If the given path is NOT absolute it is interpreted relative to this directory.

path - is the path the files to collect must match. If this path is NOT absolute it is interpreted relative to the directory given by cwd.

fileType - is the type of the files to collect or null if files of any type are acceptable.

list - is the list where to add the collected files.

Returns:

false if the path is a regular string and true if the given path contains at least one wildcard ( '*' or '?').

collectMatchingFiles

private void collectMatchingFiles(File cwd,
                                  List<ResourcePathNode<Pattern>> segments,
                                  int segmentIndex,
                                  FileType fileType,
                                  List<File> list)

This method adds all files matching with the given path and fileType to the list.

Parameters:

cwd - is the current working directory and should therefore point to an existing directory. If the given path is NOT absolute it is interpreted relative to this directory.

segments - is the path the files to collect must match. If this path is NOT absolute it is interpreted relative to the directory given by cwd.

segmentIndex - is the current index in pathChars for the collection process.

fileType - is the type of the files to collect or null if files of any type are acceptable.

list - is the list where to add the collected files.