com.izforge.izpack.util.file.types

Class Path

java.lang.Object

com.izforge.izpack.util.file.types.DataType

com.izforge.izpack.util.file.types.Path

All Implemented Interfaces:

Cloneable

public class Path
extends DataType
implements Cloneable

This object represents a path as used by CLASSPATH or PATH environment variable.

<sometask>
<somepath>
<pathelement location="/path/to/file.jar" />
<pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
<pathelement location="/path/to/file3.jar" />
<pathelement location="/path/to/file4.jar" />
</somepath>
</sometask>


The object implemention sometask must provide a method called createSomepath which returns an instance of Path. Nested path definitions are handled by the Path object and must be labeled pathelement.

The path element takes a parameter path which will be parsed and split into single elements. It will usually be used to define a path from an environment variable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Path.PathElement Helper class, holds the nested <pathelement> values.

Constructor Summary

Constructors

Constructor and Description
Path() Construct an empty Path.
Path(InstallData idata, String path) Invoked by IntrospectionHelper for setXXX(Path p) attribute setters.

Method Summary

Modifier and Type	Method and Description
void	add(Path path) Adds a nested path
void	addDirset(DirSet dset) Adds a nested <dirset> element.
void	addExisting(Path source) Adds the components on the given path which exist to this Path.
void	addExisting(Path source, boolean tryUserDir) Same as addExisting, but support classpath behavior if tryUserDir is true.
void	addFilelist(FileList fl) Adds a nested <filelist> element.
void	addFileset(FileSet fs) Adds a nested <fileset> element.
void	append(Path other) Append the contents of the other Path instance to this.
Object	clone() Return a Path that holds the same elements as this instance.
Path	createPath() Creates a nested <path> element.
Path.PathElement	createPathElement() Creates the nested <pathelement> element.
String[]	list() Returns all path elements defined by this and nested path objects.
void	setLocation(File location) Adds a element definition to the path.
void	setPath(InstallData idata, String path) Parses a path definition and creates single PathElements.
int	size() How many parts does this Path instance consist of.
String	toString() Returns a textual representation of the path, which can be used as CLASSPATH or PATH environment variable definition.
static String	translateFile(String source) Returns its argument with all file separator characters replaced so that they match the local OS conventions.
protected static boolean	translateFileSep(StringBuffer buffer, int pos) Translates all occurrences of / or \ to correct separator of the current platform and returns whether it had to do any replacements.
static String[]	translatePath(InstallData idata, String source) Splits a PATH (with : or ; as separators) into its parts.

Methods inherited from class com.izforge.izpack.util.file.types.DataType

getDescription, isChecked, noChildrenAllowed, setChecked, setDescription, tooManyAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path(InstallData idata,
            String path)
     throws Exception

Invoked by IntrospectionHelper for setXXX(Path p) attribute setters.

Parameters:

idata - the install data

path - the path definition.

Throws:

Exception

Path

public Path()

Construct an empty Path.

Method Detail

setLocation

public void setLocation(File location)
                 throws Exception

Adds a element definition to the path.

Parameters:

location - the location of the element to add (must not be null nor empty.

Throws:

Exception

setPath

public void setPath(InstallData idata,
                    String path)
             throws Exception

Parses a path definition and creates single PathElements.

Parameters:

path - the String path definition.

Throws:

Exception

createPathElement

public Path.PathElement createPathElement()
                                   throws Exception

Creates the nested <pathelement> element.

Throws:

Exception

addFileset

public void addFileset(FileSet fs)
                throws Exception

Adds a nested <fileset> element.

Throws:

Exception

addFilelist

public void addFilelist(FileList fl)
                 throws Exception

Adds a nested <filelist> element.

Throws:

Exception

addDirset

public void addDirset(DirSet dset)
               throws Exception

Adds a nested <dirset> element.

Throws:

Exception

add

public void add(Path path)
         throws Exception

Adds a nested path

Throws:

Exception

Since:

Ant 1.6

createPath

public Path createPath()
                throws Exception

Creates a nested <path> element.

Throws:

Exception

append

public void append(Path other)
            throws Exception

Append the contents of the other Path instance to this.

Throws:

Exception

addExisting

public void addExisting(Path source)
                 throws Exception

Adds the components on the given path which exist to this Path. Components that don't exist, aren't added.

Parameters:

source - - source path whose components are examined for existence

Throws:

Exception

addExisting

public void addExisting(Path source,
                        boolean tryUserDir)
                 throws Exception

Same as addExisting, but support classpath behavior if tryUserDir is true. Classpaths are relative to user dir, not the project base. That used to break jspc test

Parameters:

source -

tryUserDir -

Throws:

Exception

list

public String[] list()
              throws Exception

Returns all path elements defined by this and nested path objects.

Returns:

list of path elements.

Throws:

Exception

toString

public String toString()

Returns a textual representation of the path, which can be used as CLASSPATH or PATH environment variable definition.

Overrides:

toString in class Object

Returns:

a textual representation of the path.

translatePath

public static String[] translatePath(InstallData idata,
                                     String source)

Splits a PATH (with : or ; as separators) into its parts.

translateFile

public static String translateFile(String source)

Returns its argument with all file separator characters replaced so that they match the local OS conventions.

translateFileSep

protected static boolean translateFileSep(StringBuffer buffer,
                                          int pos)

Translates all occurrences of / or \ to correct separator of the current platform and returns whether it had to do any replacements.

size

public int size()
         throws Exception

How many parts does this Path instance consist of.

Throws:

Exception

clone

public Object clone()

Return a Path that holds the same elements as this instance.

Overrides:

clone in class Object