FileUtilLimitedImpl (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.component.base.AbstractComponent
- - net.sf.mmm.util.component.base.AbstractLoggableComponent
  - - net.sf.mmm.util.file.base.FileUtilLimitedImpl

All Implemented Interfaces:

FileUtilLimited

Direct Known Subclasses:

FileUtilImpl
```
public class FileUtilLimitedImpl
extends AbstractLoggableComponent
implements FileUtilLimited
```
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

protected static String HOME_ROOT
The typical home directory of the user "root" under Unix/Linux.

private static FileUtilLimited instance
- 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

Fields
Modifier and Type	Field and Description
`protected static String`	`HOME_ROOT` The typical home directory of the user "root" under Unix/Linux.
`private static FileUtilLimited`	`instance`

Constructor Summary

Constructors
Constructor and Description

FileUtilLimitedImpl()
The constructor.

Constructors
Constructor and Description
`FileUtilLimitedImpl()` The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`.
`static FileUtilLimited`	`getInstance()` This method gets the singleton instance of this `FileUtilLimitedImpl`.
`protected String`	`getUserHomeDirectoryPath()`
`protected String`	`getUserLogin()`
`protected String`	`normalizeHome(String path)` Normalize the potential home segment of the path (if starts with ~ such as "~/.ssh", "~root/" or "~admin/..").
`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`.

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent
createLogger, doInitialize, 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

Field Detail
- HOME_ROOT
```
protected static final String HOME_ROOT
```
  The typical home directory of the user "root" under Unix/Linux.
  
  See Also:
  
  Constant Field Values
- instance
```
private static FileUtilLimited instance
```

Constructor Detail
- FileUtilLimitedImpl
```
public FileUtilLimitedImpl()
```
  The constructor.

Method Detail

getInstance
```
public static FileUtilLimited getInstance()
```
This method gets the singleton instance of this FileUtilLimitedImpl.
ATTENTION:
Please read Cdi.GET_INSTANCE before using.

Returns:

the singleton instance.

normalizePath
```
public String normalizePath(String path)
```
Description copied from interface: FileUtilLimited

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

Specified by:

normalizePath in interface FileUtilLimited

Parameters:

path - is the path to resolve.

Returns:

the resolved path.

See Also:

FileUtilLimited.normalizePath(String, char)

normalizePath

public String normalizePath(String path,
                            char separator)

Description copied from interface: FileUtilLimited

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.

Specified by:: normalizePath in interface FileUtilLimited
Parameters:: path - is the path to resolve.; separator - is the character to use as file separator.
Returns:: the resolved path.

normalizeHome
```
protected String normalizeHome(String path)
```
Normalize the potential home segment of the path (if starts with ~ such as "~/.ssh", "~root/" or "~admin/..").

Parameters:

path - is the path where to normalize the home segment.

Returns:

the normalized path.

getUserHomeDirectoryPath
```
protected String getUserHomeDirectoryPath()
```
Returns:

the path to the home directory of the current user.

getUserLogin
```
protected String getUserLogin()
```
Returns:

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

getExtension
```
public String getExtension(String filename)
```
Description copied from interface: FileUtilLimited

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.

Specified by:

getExtension in interface FileUtilLimited

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
```
public String getBasename(String filename)
```
Description copied from interface: FileUtilLimited

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

Specified by:

getBasename in interface FileUtilLimited

Parameters:

filename - is the path to a file or directory.

Returns:

the basename of the given filename.

filename	`getBasename(filename)`

/	/
\/\	\
/.	.
/foo.bar	foo.bar
/foo/bar/	bar
c:\\
c:\\foo	foo
http://foo.org/bar	bar

getDirname
```
public String getDirname(String filename)
```
Description copied from interface: FileUtilLimited

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

filename FileUtilLimited.getDirname(String)

foo .

/foo /

/foo/bar /foo

/foo/bar/ /foo

./foo/bar/ ./foo

./foo/bar/../ ./foo/bar

Specified by:

getDirname in interface FileUtilLimited

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:

FileUtilLimited.normalizePath(String)

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

Class FileUtilLimitedImpl

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

HOME_ROOT

instance

Constructor Detail

FileUtilLimitedImpl

Method Detail

getInstance

normalizePath

normalizePath

normalizeHome

getUserHomeDirectoryPath

getUserLogin

getExtension

getBasename

getDirname