simple.util.net
Interface Path

All Known Implementing Classes:
PathParser

public interface Path

The Path represents the path part of a URI. This provides the various components of the URI path to the user. The normalization of the path is the conversion of the path given into it's actual path by removing the references to the parent directorys and to the current dir.

If the path that this represents is /usr/bin/../etc/./README then the actual path, normalized, is /usr/etc/README. This will also provide a localization from the path. The localization is there if a second extension exists within the path, for example if the path was /usr/bin/file.ext.ext. The second extension will be parsed so that all the characters before the first underscore character, '_', will define the language and all the characters after the first underscore will define the country, for example index.en_US.html will have the language en and the country would be US. This should only support two character codes for both language and country.

Author:
Niall Gallagher
See Also:
PathParser

Method Summary
 java.lang.String getCountry()
          This will return the country that this path has taken from the locale of the path.
 java.lang.String getDirectory()
          This will return the highest directory that exists within the path.
 java.lang.String getExtension()
          This will return the extension that the file name contains.
 java.lang.String getLanguage()
          This will return the language that this path has taken from the locale of the path.
 java.lang.String getName()
          This will return the full name of the file without the path.
 java.lang.String getPath()
          This will return the normalized path.
 java.lang.String getRelative(java.lang.String path)
          This will return the path as it is relative to the issued path.
 java.lang.String[] getSegments()
          This method is used to break the path into individual parts called segments, see RFC 2396.
 java.lang.String toString()
          This will return the normalized path.
 

Method Detail

getLanguage

java.lang.String getLanguage()
This will return the language that this path has taken from the locale of the path. For example a file name of file.en_US.extension produces a language of en. This will return null if there was no language information within the path.

Returns:
returns the locale language this path contains

getCountry

java.lang.String getCountry()
This will return the country that this path has taken from the locale of the path. For example a file name of file.en_US.extension produces a country of US. This will return null if there was no country information within the path.

Returns:
returns the locale country this path contains

getExtension

java.lang.String getExtension()
This will return the extension that the file name contains. For example a file name file.en_US.extension will produce an extension of extension. This will return null if the path contains no file extension.

Returns:
this will return the extension this path contains

getName

java.lang.String getName()
This will return the full name of the file without the path. As regargs the definition of the path in RFC 2396 the name would be considered the last path segment. So if the path was /usr/README the name is README. Also for directorys the name of the directory in the last path segment is returned. This returns the name without any of the path parameters. As RFC 2396 defines the path to have path parameters after the path segments.

Returns:
this will return the name of the file in the path

getPath

java.lang.String getPath()
This will return the normalized path. The normalized path is the path without any references to its parent or itself. So if the path to be parsed is /usr/../etc/./ the path is /etc/. If the path that this represents is a path with an immediate back reference then this will return null. This is the path with all its information even the parameter information if it was defined in the path.

Returns:
this returns the normalize path without ../ or ./

getSegments

java.lang.String[] getSegments()
This method is used to break the path into individual parts called segments, see RFC 2396. This can be used as an easy way to compare paths and to examine the directory tree that the path points to. For example, if an path was broken from the string /usr/bin/../etc then the segments returned would be usr and etc as the path is normalized before the segments are extracted.

Returns:
return all the path segments within the directory

getDirectory

java.lang.String getDirectory()
This will return the highest directory that exists within the path. This is used to that files within the same path can be acquired. An example of that this would do given the path /pub/./bin/README would be to return the highest directory path /pub/bin/. The "/" character will allways be the last character in the path.

Returns:
this method will return the highest directory

getRelative

java.lang.String getRelative(java.lang.String path)
This will return the path as it is relative to the issued path. This in effect will chop the start of this path if it's start matches the highest directory of the given path as of getDirectory. This is useful if paths that are relative to a specific location are required. To illustrate what this method will do the following example is provided. If this object represented the path string /usr/share/rfc/rfc2396.txt and the issued path was /usr/share/text.txt then this will return the path string /rfc/rfc2396.txt.

Parameters:
path - the path prefix to acquire a relative path
Returns:
returns a path relative to the one it is given otherwize this method will return null

toString

java.lang.String toString()
This will return the normalized path. The normalized path is the path without any references to its parent or itself. So if the path to be parsed is /usr/../etc/./ the path is /etc/. If the path that this represents is a path with an immediate back reference then this will return null. This is the path with all its information even the parameter information if it was defined in the path.

Overrides:
toString in class java.lang.Object
Returns:
this returns the normalize path without ../ or ./