tfw.base.util.file

Class FileToolT

java.lang.Object

tfw.base.util.file.FileToolT

Direct Known Subclasses:

FileToolE, FileToolP

public class FileToolT
extends java.lang.Object

A pack of tool functions for file operations.
Throws exceptions.

Author:

Typhoon.Free.Wolf

Field Summary

Fields

Modifier and Type	Field and Description
private static short	FILE_OPERATION_PATH_DEPTH_LIMIT

Constructor Summary

Constructors

Constructor and Description
FileToolT()

Method Summary

Modifier and Type	Method and Description
static java.io.Serializable[]	copy(java.lang.Object oFileSrc, java.lang.Object oFileDest, char chOverrideMode, char chAttributesMode) Simple ordinary file to ordinary file copy that returns a single result.
static java.util.List<java.io.Serializable[]>	deepCopy(java.lang.Object oFileSrc, java.lang.Object oFileDest, char chOverrideMode, boolean blFlagPrint) Performs deep copy.
static java.util.List<java.io.Serializable[]>	deepCopy(java.lang.Object oFileSrc, java.lang.Object oFileDest, char chOverrideMode, int intDepthLimit, char chChildFailureWay, char chAttributesMode, boolean blOnlyCopyDirs, char chRecordMode, boolean blFlagPrint) Performs deep copy. May need a flow picture to explain the inner logic.
static java.util.List<java.io.Serializable[]>	deepList(java.lang.Object oFile, boolean blFlagPrint) Performs deep list.
static java.util.List<java.io.Serializable[]>	deepList(java.lang.Object oFile, boolean blFlagDirsFirst, int intDepthLimit, char chChildFailureWay, char chFileType, char chRecordMode, boolean blFlagPrint) Performs deep list.
static java.io.Serializable[]	deepMkdir_(java.lang.Object oFile, int intDepthLimit, boolean blForceSkip, char chRecordMode, boolean blFlagPrint) Deprecated. Unformal, may change or remove soon.
static java.io.Serializable[]	deepRemove__(java.lang.Object oFile) Deprecated. Unformal, may change or remove soon.
static java.io.Serializable[]	deepRemove_(java.lang.Object oFile, int intDepthLimit, boolean blForceSkip, char chRecordMode, boolean blFlagPrint) Deprecated. Unformal, may change or remove soon.
static java.util.Comparator<java.io.File>	getFullNameComparator(boolean blFlagDirsFirst) Gets a file name comparator that compares the full name (absolute paths) of the files.
static java.lang.String	getName(java.lang.Object oFile) Gets the file name.
static boolean	mkdir_(java.lang.Object oFile) Deprecated. Unformal, may change or remove soon.
static boolean	mkdirP_(java.lang.Object oFile) Deprecated. Unformal, may change or remove soon.
static java.io.File	o2f(java.lang.Object oFile) Converts the incoming object to a file object.
static boolean	rm_(java.lang.Object oFile) Deprecated. Unformal, may change or remove soon.
static java.io.Serializable[]	rmForce__(java.lang.Object oFile, int intDepthLimit) Deprecated. Unformal, may change or remove soon.
static void	sortByName(java.io.File[] file1d, boolean blDirectoriesFirst) Sorts an array of files by there full name (absolute paths).
static void	sortByName(java.util.List<java.io.File> listFiles, boolean blDirectoriesFirst) Sorts an array of files by there full name (absolute paths).
static java.lang.String[]	splitNameByPostfix(java.lang.Object oFile) Splits a file name into main part and postfix part by the final dot.
static boolean	touch_(java.lang.Object oFile) Deprecated. Unformal, may change or remove soon.
static char[]	userPermissionChars(java.lang.Object oFile) Gets user permission of an existed file in a char array formation.
static java.lang.String	userPermissionString(java.lang.Object oFile) Gets user permission of an existed file in a text string formation.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_OPERATION_PATH_DEPTH_LIMIT

private static final short FILE_OPERATION_PATH_DEPTH_LIMIT

See Also:

Constant Field Values

Constructor Detail

FileToolT

public FileToolT()

Method Detail

o2f

public static java.io.File o2f(java.lang.Object oFile)

Converts the incoming object to a file object.

Parameters:

oFile - - The incoming object.

Returns:

The file object.

getName

public static java.lang.String getName(java.lang.Object oFile)

Gets the file name.

Parameters:

oFile - - Incoming file or file name.

Returns:

The file name.

getFullNameComparator

public static java.util.Comparator<java.io.File> getFullNameComparator(boolean blFlagDirsFirst)

Gets a file name comparator that compares the full name (absolute paths) of the files.

Parameters:

blFlagDirsFirst - - A boolean flag that indicates whether move directories to the front.

• true : Settles the directories to the front.
  
• false: Settles all the files only by there (full) names.
  

Returns:

The file name comparator.

sortByName

public static void sortByName(java.io.File[] file1d,
                              boolean blDirectoriesFirst)

Sorts an array of files by there full name (absolute paths).

Parameters:

file1d - - Incoming file array.

blDirectoriesFirst - - A boolean flag that indicates whether move directories to the front.

• true : Settles the directories to the front.
  
• false: Settles all the files only by there (full) names.
  

sortByName

public static void sortByName(java.util.List<java.io.File> listFiles,
                              boolean blDirectoriesFirst)

Sorts an array of files by there full name (absolute paths).

Parameters:

listFiles - - Incoming file list.

blDirectoriesFirst - - A boolean flag that indicates whether move directories to the front.

• true : Settles the directories to the front.
  
• false: Settles all the files only by there (full) names.
  

splitNameByPostfix

public static java.lang.String[] splitNameByPostfix(java.lang.Object oFile)

Splits a file name into main part and postfix part by the final dot.

Parameters:

oFile - - Incoming file or file name.

Returns:

An array of split result:

• [0]: The main part before the final dot (if there is such part).
  
• [1]: The postfix part before the final dot (if there is such part).
  

userPermissionChars

public static char[] userPermissionChars(java.lang.Object oFile)

Gets user permission of an existed file in a char array formation.

Parameters:

oFile - - Incoming file or file name.

Returns:

A char array of user permission:

• [0]: 'r' means readable while '-' means not.
  
• [1]: 'w' means writable while '-' means not.
  
• [2]: 'x' means executable while '-' means not.
  

userPermissionString

public static java.lang.String userPermissionString(java.lang.Object oFile)

Gets user permission of an existed file in a text string formation.

Parameters:

oFile - - Incoming file or file name.

Returns:

A text string of user permission:

• Character at index [0]: 'r' means readable while '-' means not.
  
• Character at index [1]: 'w' means writable while '-' means not.
  
• Character at index [2]: 'x' means executable while '-' means not.
  

copy

public static java.io.Serializable[] copy(java.lang.Object oFileSrc,
                                          java.lang.Object oFileDest,
                                          char chOverrideMode,
                                          char chAttributesMode)

Simple ordinary file to ordinary file copy that returns a single result.

Parameters:

oFileSrc - Source file, directory or its name.

oFileDest - - Destination file, directory or its name.

chOverrideMode - - A character flag that indicates the override mode:

• 'O' or 'o': For a non-directory file, override while the destination file exists.
  
• 'S' or 's': For a non-directory file, skip and continue while the destination file exists.
  
• 'F', 'f' or other: For a non-directory file, consider it as a failure while the destination file exists.
  

chAttributesMode - - A character flag that indicates the attributes mode:

• 'T' or 't': Try to use the time stamp from the source file or directory to the destination one; "last modify" time stamp is currently supported.
  
• 'P' or 'p': Try to use the permission attributes from the source file or directory to the destination one; "owner read" , "owner write" and "owner execute(or enter directory)" are currently supported; other permission attributes could not be controlled from Java directly.
  
• 'A' or 'a': Try to use all the attributes above from the source file or directory to the destination one.
  
• 'N', 'n' or other: Not to copy any attribute from the source file or directory to the destination one.
  

Note time stamp attributes would only be copied while the file or directory has been successfully copied.

Returns:

A a 4 slot array:

• Index [0]: Primary information, a Boolean object that indicates whether this file is successfully copied:
  
  • true : Succeeded.
    
  • false or null: Failed copying.
    
• Index [1]: The object of source file; may be null in some cases.
  
• Index [2]: The object of destination file; may be null in some cases.
  
• Index [3]: Assistant information, a text string of failure reason; may be null in some cases.
  

deepCopy

public static java.util.List<java.io.Serializable[]> deepCopy(java.lang.Object oFileSrc,
                                                              java.lang.Object oFileDest,
                                                              char chOverrideMode,
                                                              boolean blFlagPrint)

Performs deep copy.

Parameters:

oFileSrc - - Source file, directory or its name.

oFileDest - - Destination file, directory or its name.

chOverrideMode - - A character flag that indicates the override mode:

• 'O' or 'o': For a non-directory file, override while the destination file exists.
  
• 'S' or 's': For a non-directory file, skip and continue while the destination file exists.
  
• 'F', 'f' or other: For a non-directory file, consider it as a failure while the destination file exists.
  

blFlagPrint - - A boolean flag that indicates whether use "System.out.println(...)" to print the course:

• true : Print.
  
• false: Not to print.
  

Note the self result would finally be confirmed and printed at the end of the method, so that the child results from recruit calling would always be printed first.

Returns:

A list that contains copy information, each element in the list is a 4 slot array:

• Index [0]: Primary information, a Boolean object that indicates whether this file is successfully copied:
  
  • true : Succeeded.
    
  • false or null: Failed copying.
    
• Index [1]: The object of source file; may be null in some cases.
  
• Index [2]: The object of destination file; may be null in some cases.
  
• Index [3]: Assistant information, a text string of failure reason; may be null in some cases.
  

deepCopy

public static java.util.List<java.io.Serializable[]> deepCopy(java.lang.Object oFileSrc,
                                                              java.lang.Object oFileDest,
                                                              char chOverrideMode,
                                                              int intDepthLimit,
                                                              char chChildFailureWay,
                                                              char chAttributesMode,
                                                              boolean blOnlyCopyDirs,
                                                              char chRecordMode,
                                                              boolean blFlagPrint)

Performs deep copy.
May need a flow picture to explain the inner logic.

Parameters:

oFileSrc - - Source file, directory or its name.

oFileDest - - Destination file, directory or its name.

chOverrideMode - - A character flag that indicates the override mode:

• 'O' or 'o': For a non-directory file, override while the destination file exists.
  
• 'S' or 's': For a non-directory file, skip and continue while the destination file exists.
  
• 'F', 'f' or other: For a non-directory file, consider it as a failure while the destination file exists.
  

intDepthLimit - - Depth limitation, would be automatically limited from 0 to DEPTH_LIMIT.

chChildFailureWay - - A character flag that indicates the response way of the failure(s) from recursive child operation(s):

• 'I' or 'i': Ignore the failure(s) from recursive child operation(s) and not mark self failure.
  
• 'S' or 's': Mark failure to self according to the failure(s) from recursive child operation(s), then skip to continue.
  
• 'F', 'f' or other: Stop for the failure(s) from recursive child operation(s) and and mark self failure.
  

chAttributesMode - - A character flag that indicates the attributes mode:

• 'T' or 't': Try to use the time stamp from the source file or directory to the destination one; "last modify" time stamp is currently supported.
  
• 'P' or 'p': Try to use the permission attributes from the source file or directory to the destination one; "owner read" , "owner write" and "owner execute(or enter directory)" are currently supported; other permission attributes could not be controlled from Java directly.
  
• 'A' or 'a': Try to use all the attributes above from the source file or directory to the destination one.
  
• 'N', 'n' or other: Not to copy any attribute from the source file or directory to the destination one.
  

Note time stamp attributes would only be copied while the file or directory has been successfully copied.

blOnlyCopyDirs - - A boolean flag that indicates whether only copy directories:

• true : Only copy directories, ignore other files.
  
• false: Copy all possible files.
  

chRecordMode - - A character flag that indicates the record mode:

• 'N' or 'n': Not to record any other things into the result.
  
• 'F' or 'f': To record all failed sub-results into the result.
  
• 'A', 'a' or other: To record all the sub-results into the result.
  

blFlagPrint - - A boolean flag that indicates whether use "System.out.println(...)" to print the course:

• true : Print.
  
• false: Not to print.
  

Note the self result would finally be confirmed and printed at the end of the method, so that the child results from recruit calling would always be printed first.

Returns:

A list that contains copy information, each element in the list is a 4 slot array:

• Index [0]: Primary information, a Boolean object that indicates whether this file is successfully copied:
  
  • true : Succeeded.
    
  • false or null: Failed copying.
    
• Index [1]: The object of source file; may be null in some cases.
  
• Index [2]: The object of destination file; may be null in some cases.
  
• Index [3]: Assistant information, a text string of failure reason; may be null in some cases.
  

deepList

public static java.util.List<java.io.Serializable[]> deepList(java.lang.Object oFile,
                                                              boolean blFlagPrint)

Performs deep list.

Parameters:

oFile - - File, directory or its name.

blFlagPrint - - A boolean flag that indicates whether use "System.out.println(...)" to print the course:

• true : Print.
  
• false: Not to print.
  

Note the self result would finally be confirmed and printed at the end of the method, so that the child results from recruit calling would always be printed first.

Returns:

A list that contains listed file(s) and information.
Each element in the list is a 3 slot array:

• Index [0]: Primary information, a Boolean object that indicates whether this file or directory is successfully listed:
  
  • true : Succeeded.
    
  • false or null: Failed listing.
    
• Index [1]: The object of this file; may be null in some cases.
  
• Index [2]: Assistant information, a text string of description.
  

deepList

public static java.util.List<java.io.Serializable[]> deepList(java.lang.Object oFile,
                                                              boolean blFlagDirsFirst,
                                                              int intDepthLimit,
                                                              char chChildFailureWay,
                                                              char chFileType,
                                                              char chRecordMode,
                                                              boolean blFlagPrint)

Performs deep list.

Parameters:

oFile - - File, directory or its name.

blFlagDirsFirst - - A boolean flag that indicates whether move directories to the front.

• true : Settles the directories to the front.
  
• false: Settles all the files only by there (full) names.
  

intDepthLimit - - Depth limitation, would be automatically limited from 0 to DEPTH_LIMIT.

chChildFailureWay - - A character flag that indicates the response way of the failure(s) from recursive child operation(s):

• 'I' or 'i': Ignore the failure(s) from recursive child operation(s) and not mark self failure.
  
• 'S' or 's': Mark failure to self according to the failure(s) from recursive child operation(s), then skip to continue.
  
• 'F', 'f' or other: Stop for the failure(s) from recursive child operation(s) and and mark self failure.
  

chFileType - - A character flag that indicates the type of the child files to be listed:

• 'D' or 'd': Only list directories.
  
• 'N' or 'n': Only list non-directory files.
  
• 'A', 'a' or other: List all the files.
  

chRecordMode - - A character flag that indicates the record mode of child results; self result would would always be recorded:

• 'N' or 'n': Not to record any child result into self result.
  
• 'G' or 'g': To record all good child results into self result.
  
• 'F' or 'f': To record all failed child results into self result.
  
• 'A', 'a' or other: To record all the child results into self result.
  

blFlagPrint - - A boolean flag that indicates whether use "System.out.println(...)" to print the course:

• true : Print.
  
• false: Not to print.
  

Note the self result would finally be confirmed and printed at the end of the method, so that the child results from recruit calling would always be printed first.

Returns:

A list that contains listed file(s) and information.
Each element in the list is a 3 slot array:

• Index [0]: Primary information, a Boolean object that indicates whether this file or directory is successfully listed:
  
  • true : Succeeded.
    
  • false or null: Failed listing.
    
• Index [1]: The object of this file; may be null in some cases.
  
• Index [2]: Assistant information, a text string of description.
  

touch_

public static boolean touch_(java.lang.Object oFile)
                      throws java.io.IOException

Deprecated. Unformal, may change or remove soon.

A warped method, creates an ordinary file.

Parameters:

oFile - - Incoming file or file name.

Returns:

A boolean flag, true means success while false means failure.

Throws:

java.io.IOException - .

mkdir_

public static boolean mkdir_(java.lang.Object oFile)

Deprecated. Unformal, may change or remove soon.

A warped method, makes a directory.

Parameters:

oFile - - Incoming directory or directory name.

Returns:

A boolean flag, true means success while false means failure.

mkdirP_

public static boolean mkdirP_(java.lang.Object oFile)

Deprecated. Unformal, may change or remove soon.

A warped method, makes directory, and also creates its parents if necessary (makes the entitle given path).

Parameters:

oFile - - Incoming directory or directory name.

Returns:

A boolean flag, true means success while false means failure.

rm_

public static boolean rm_(java.lang.Object oFile)

Deprecated. Unformal, may change or remove soon.

A warped method, removes a file.

Parameters:

oFile - - Incoming file or file name.

Returns:

A boolean flag, true means success while false means failure.

deepMkdir_

public static java.io.Serializable[] deepMkdir_(java.lang.Object oFile,
                                                int intDepthLimit,
                                                boolean blForceSkip,
                                                char chRecordMode,
                                                boolean blFlagPrint)

Deprecated. Unformal, may change or remove soon.

Performs deep "mkdir".

Parameters:

oFile - - File, directory or its name.

intDepthLimit - - Depth limitation, would be automatically limited from 0 to DEPTH_LIMIT.

blForceSkip - - A boolean flag that indicates whether skip fail points as possible:

• true : Skip fail points as possible.
  
• false: Stop and return at any fail point.
  

chRecordMode - - A character flag that indicates the record mode:

• 'n': Not to record any other things into the result.
  
• 'f': To record all failed sub-results into the result.
  
• 'a' or other: To record all the sub-results into the result.
  

blFlagPrint - - A boolean flag that indicates whether use "System.out.println(...)" to print the course:

• true : Print.
  
• false: Not to print.
  

Returns:

A 3~4 slot array of final "mkdir" result:

• Index [0]: Primary information, a Boolean object that indicates whether this directory is successfully created or already exists:
  
  • true : Successfully created, or already exists.
    
  • false or null: Not exist, and failed creating.
    
• Index [1]: The object of the directory to be or has been created; may be null in some cases.
  
• Index [2]: Assistant information, a list of sub result (if record exists).
  

deepRemove_

public static java.io.Serializable[] deepRemove_(java.lang.Object oFile,
                                                 int intDepthLimit,
                                                 boolean blForceSkip,
                                                 char chRecordMode,
                                                 boolean blFlagPrint)

Deprecated. Unformal, may change or remove soon.

Performs deep remove.

Parameters:

oFile - - File, directory or its name.

intDepthLimit - - Depth limitation, would be automatically limited from 0 to DEPTH_LIMIT.

blForceSkip - - A boolean flag that indicates whether skip fail points as possible:

• true : Skip fail points as possible.
  
• false: Stop and return at any fail point.
  

chRecordMode - - A character flag that indicates the record mode:

• 'n': Not to record any other things into the result.
  
• 'f': To record all failed sub-results into the result.
  
• 'a' or other: To record all the sub-results into the result.
  

blFlagPrint - - A boolean flag that indicates whether use "System.out.println(...)" to print the course:

• true : Print.
  
• false: Not to print.
  

Returns:

A 3~4 slot array of final remove result:

• Index [0]: Primary information, a Boolean object that indicates whether this directory is successfully removed:
  
  • true : Successfully removed.
    
  • false or null: Failed removing.
    
• Index [1]: The object of the directory to be or has been created; may be null in some cases.
  
• Index [2]: Assistant information, a list of sub result (if record exists).
  

deepRemove__

public static java.io.Serializable[] deepRemove__(java.lang.Object oFile)

Deprecated. Unformal, may change or remove soon.

Removes a file by force, no matter an ordinary file, an empty directory or a non-empty directory.

Parameters:

oFile - - Incoming file or file name.

Returns:

An array of remove result, not to be null:

• [0]: A boolean flag, true means success while false means failure.
  
• [1]: The file name of the failure position.
  

rmForce__

public static java.io.Serializable[] rmForce__(java.lang.Object oFile,
                                               int intDepthLimit)

Deprecated. Unformal, may change or remove soon.

Removes a file by force, no matter an ordinary file, an empty directory or a non-empty directory.

Parameters:

oFile - - Incoming file or file name.

intDepthLimit - - Depth limitation, would be automatically limited from 0 to DEPTH_LIMIT.

Returns:

An array of remove result, not to be null:

• [0]: A boolean flag, true means success while false means failure.
  
• [1]: The file name of the failure position.