net.sf.mmm.util.file.api

Interface FileUtilLimited

All Known Subinterfaces:

FileUtil

All Known Implementing Classes:

FileUtilImpl, FileUtilLimitedImpl

@ComponentSpecification
public interface FileUtilLimited

This is the interface for a collection of utility functions for File handling and manipulation.
NOTE:
Since Java7 there is also Files that offers similar and additional features. However this is not supported in limited environments such as e.g. GWT.

Since:

5.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

FileUtilLimitedImpl

Field Summary

Fields

Modifier and Type	Field and Description
static File[]	NO_FILES An empty file array.
static String	PATH_SEGMENT_CURRENT The path segment indicating the current folder itself.
static String	PATH_SEGMENT_PARENT The path segment indicating the parent folder.
static String	PROPERTY_TMP_DIR The key of the system property "java.io.tmpdir".
static String	PROPERTY_USER_HOME The key of the system property "user.home".

Method Summary

Modifier and Type	Method and Description
String	getBasename(String filename) This method gets the basename of the given filename (path).
String	getDirname(String filename) This method gets the directory-name of the given filename (path).
String	getExtension(String filename) This method extracts the extension from the given filename.
String	normalizePath(String path) This method is a shortcut for normalizePath(path, File.separatorChar).
String	normalizePath(String path, char separator) This method normalizes a given path.

Field Detail

PATH_SEGMENT_CURRENT

static final String PATH_SEGMENT_CURRENT

The path segment indicating the current folder itself.

See Also:

Constant Field Values

PATH_SEGMENT_PARENT

static final String PATH_SEGMENT_PARENT

The path segment indicating the parent folder.

See Also:

Constant Field Values

PROPERTY_USER_HOME

static final String PROPERTY_USER_HOME

The key of the system property "user.home". It contains the home directory of the user that started this JVM.
Examples are /home/mylogin or C:\Windows\Profiles\mylogin.

See Also:

Constant Field Values

PROPERTY_TMP_DIR

static final String PROPERTY_TMP_DIR

The key of the system property "java.io.tmpdir". It contains the directory to use for temporary files.
Examples are /tmp, C:\Temp or /usr/local/tomcat/temp.

See Also:

Constant Field Values

NO_FILES

static final File[] NO_FILES

An empty file array.

Method Detail

normalizePath

String normalizePath(String path,
                     char separator)

This method normalizes a given path. It will resolve ".." and "." segments, normalize backslashes and remove duplicated slashes. Further it can resolve "~" at the beginning of the path (like in bash-scripts, etc.). Therefore this method resolves the path in such situations (e.g. to "/home/login/foo") and returns a physical path.
Here are some examples assuming that separator is '/' (backslashes are NOT escaped):

path	normalizePath(path)
"folder/subfolder//../.\some.file"	"folder/some.file"
"../.\some.file"	"../some.file"
"http://www.host.com/foo/bar/./test/.././.."	"http://www.host.com/foo"
"\\unc.host\printers\pr3761"	"\\unc.host\printers\pr3761"
"~/documents/index.html"	home+ "/documents/index.html"
"~root/subfolder/../folder/.//index.html"	"/root/folder/index.html"

ATTENTION:
Normalizing home-directories of other users (e.g. "~user/") makes various assumptions and is NOT guaranteed to be correct in any case.

Parameters:

path - is the path to resolve.

separator - is the character to use as file separator.

Returns:

the resolved path.

normalizePath

String normalizePath(String path)

This method is a shortcut for normalizePath(path, File.separatorChar).

Parameters:

path - is the path to resolve.

Returns:

the resolved path.

See Also:

normalizePath(String, char)

getExtension

String getExtension(String filename)

This method extracts the extension from the given filename.
Example: getExtension("test.java") would return "java".
ATTENTION:
If the filename is just a dot followed by the extension (e.g. ".java"), the empty string is returned.

Parameters:

filename - is the filename and may include an absolute or relative path.

Returns:

the extension of the given filename excluding the dot in lowercase or the empty string if NOT present.

getBasename

String getBasename(String filename)

This method gets the basename of the given filename (path). The basename is the raw name of the file without the path.
Examples:

filename	getBasename(filename)
/	/
\/\	\
/.	.
/foo.bar	foo.bar
/foo/bar/	bar
c:\\
c:\\foo	foo
http://foo.org/bar	bar

Parameters:

filename - is the path to a file or directory.

Returns:

the basename of the given filename.

getDirname

String getDirname(String filename)

This method gets the directory-name of the given filename (path).
Examples:

filename	getDirname(String)
foo	.
/foo	/
/foo/bar	/foo
/foo/bar/	/foo
./foo/bar/	./foo
./foo/bar/../	./foo/bar

Parameters:

filename - is the path to a file or directory.

Returns:

the path to the directory containing the file denoted by the given filename.

See Also:

normalizePath(String)