org.alfresco.jlan.server.filesys

Class FileName

java.lang.Object

org.alfresco.jlan.server.filesys.FileName

public final class FileName
extends java.lang.Object

Provides utility methods for manipulating file names.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DataStreamName
static char	DOS_SEPERATOR
static java.lang.String	DOS_SEPERATOR_STR
static java.lang.String	MainDataStreamName
static java.lang.String	NTFSStreamSeperator

Constructor Summary

Constructors

Constructor and Description
FileName()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	buildPath(java.lang.String dev, java.lang.String path, java.lang.String filename, char sep) Build a path using the specified components.
static boolean	containsStreamName(java.lang.String path) Test if a file name contains an NTFS stream name
static java.lang.String	convertSeperators(java.lang.String path, char sep) Convert the file seperators in a path to the specified path seperator character.
static java.lang.String	getParentPathForStream(java.lang.String streamPath) Get the path to the parent file of an NTFS stream
static java.lang.String	makeRelativePath(java.lang.String basePath, java.lang.String fullPath) Make a path relative to the base path for the specified path.
static java.lang.String	mapPath(java.lang.String base, java.lang.String path) Map the input path to a real path, this may require changing the case of various parts of the path.
static java.lang.String	normalizePath(java.lang.String path) Normalize the path to uppercase the directory names and keep the case of the file name.
static java.lang.String	removeFileName(java.lang.String path) Remove the file name from the specified path string.
static java.lang.String[]	splitAllPaths(java.lang.String path) Split the path into all the component directories and filename
static java.lang.String[]	splitPath(java.lang.String path) Split the path into seperate directory path and file name strings.
static java.lang.String[]	splitPath(java.lang.String path, char sep) Split the path into seperate directory path and file name strings.
static java.lang.String[]	splitPath(java.lang.String path, char sep, java.lang.String[] list) Split the path into seperate directory path and file name strings.
static java.lang.String[]	splitPathStream(java.lang.String path) Split a path string into directory path, file name and stream name components

Methods inherited from class java.lang.Object

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

Field Detail

DOS_SEPERATOR

public static final char DOS_SEPERATOR

See Also:

Constant Field Values

DOS_SEPERATOR_STR

public static final java.lang.String DOS_SEPERATOR_STR

See Also:

Constant Field Values

NTFSStreamSeperator

public static final java.lang.String NTFSStreamSeperator

See Also:

Constant Field Values

MainDataStreamName

public static final java.lang.String MainDataStreamName

See Also:

Constant Field Values

DataStreamName

public static final java.lang.String DataStreamName

See Also:

Constant Field Values

Constructor Detail

FileName

public FileName()

Method Detail

buildPath

public static java.lang.String buildPath(java.lang.String dev,
                         java.lang.String path,
                         java.lang.String filename,
                         char sep)

Build a path using the specified components.

Parameters:

dev - java.lang.String

path - java.lang.String

filename - java.lang.String

sep - char

Returns:

java.lang.String

convertSeperators

public static java.lang.String convertSeperators(java.lang.String path,
                                 char sep)

Convert the file seperators in a path to the specified path seperator character.

Parameters:

path - java.lang.String

sep - char

Returns:

java.lang.String

mapPath

public static final java.lang.String mapPath(java.lang.String base,
                       java.lang.String path)
                                      throws java.io.FileNotFoundException

Map the input path to a real path, this may require changing the case of various parts of the path. The base path is not checked, it is assumed to exist.

Parameters:

base - java.lang.String

path - java.lang.String

Returns:

java.lang.String

Throws:

java.io.FileNotFoundException - The path could not be mapped to a real path.

removeFileName

public static final java.lang.String removeFileName(java.lang.String path)

Remove the file name from the specified path string.

Parameters:

path - java.lang.String

Returns:

String

splitPath

public static java.lang.String[] splitPath(java.lang.String path)

Split the path into seperate directory path and file name strings.

Parameters:

path - Full path string.

Returns:

String[] String[0] contains the folder String[1] contains the filename

splitPath

public static java.lang.String[] splitPath(java.lang.String path,
                           char sep)

Split the path into seperate directory path and file name strings.

Parameters:

path - Full path string.

sep - Path seperator character.

Returns:

String[] String[0] contains the folder String[1] contains the filename

splitPath

public static java.lang.String[] splitPath(java.lang.String path,
                           char sep,
                           java.lang.String[] list)

Split the path into seperate directory path and file name strings.

Parameters:

path - Full path string.

sep - Path seperator character.

list - String list to return values in, or null to allocate

Returns:

String[]

splitAllPaths

public static java.lang.String[] splitAllPaths(java.lang.String path)

Split the path into all the component directories and filename

Parameters:

path - String

Returns:

String[]

splitPathStream

public static java.lang.String[] splitPathStream(java.lang.String path)

Split a path string into directory path, file name and stream name components

Parameters:

path - Full path string.

Returns:

java.lang.String[]

containsStreamName

public static boolean containsStreamName(java.lang.String path)

Test if a file name contains an NTFS stream name

Parameters:

path - String

Returns:

boolean

normalizePath

public static final java.lang.String normalizePath(java.lang.String path)

Normalize the path to uppercase the directory names and keep the case of the file name.

Parameters:

path - String

Returns:

String

makeRelativePath

public static final java.lang.String makeRelativePath(java.lang.String basePath,
                                java.lang.String fullPath)

Make a path relative to the base path for the specified path.

Parameters:

basePath - String

fullPath - String

Returns:

String

getParentPathForStream

public static final java.lang.String getParentPathForStream(java.lang.String streamPath)

Get the path to the parent file of an NTFS stream

Parameters:

streamPath - String

Returns:

String