Classpath (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.file.Classpath

```
public class Classpath
extends java.lang.Object
```
Represents a classpath definition whereas the elements are already parsed an validated.
Since version 1.2 elements are also collected from patterns with wildcards (e.g. "base.jar:lib/*.jar:xalan.jar")

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String DEFAULT_SEPARATOR

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`DEFAULT_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description
`Classpath()` Initialize the new instance with the classpath from System property "java.class.path" or from the Class-Path value in the manifest file of the sole JAR file if the program was started with option -jar.
`Classpath(java.util.Collection<java.lang.String> classpathElements)` Initialize the new instance with the given elements.
`Classpath(java.lang.String classpath)` Initialize the new instance with a classpath definition.
`Classpath(java.lang.String[] classpathElements)` Initialize the new instance with the given elements.
`Classpath(java.lang.String classpath, java.lang.String separator)` Initialize the new instance with a classpath definition where the separator is the one given as parameter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClasspathElement[]`	`allElements()` Returns all classpath elements.
`protected void`	`appendElement(java.lang.String elementName)`
`protected void`	`basicAppendElement(java.lang.String elementName)`
`protected ClasspathElement[]`	`collectElements(boolean valid)`
`static Classpath`	`create(java.lang.String... classpathElements)` Returns a new Classpath object initialized with the given path elemments.
`protected ClasspathElement[]`	`elementArray(java.util.List<ClasspathElement> elementList)`
`ClasspathElement[]`	`elementsContaining(java.lang.String filename)` Returns all elements that contain a file with the specified name.
`protected ClasspathElement[]`	`elementsWithFile(java.lang.String filename)` Returns all elements that contain a file with the given name.
`protected ClasspathElement[]`	`elementsWithFile(java.lang.String filename, boolean onlyFirst)` Returns all elements or the first element that contain(s) a file with the given name.
`protected FileUtil`	`fileUtil()`
`ClasspathElement`	`firstElementContaining(java.lang.String filename)` Returns the first element that contains a file with the specified name or null if the file cannot be found.
`protected java.util.List<ClasspathElement>`	`getElements()`
`protected void`	`init(java.lang.String classpath, java.lang.String separator)`
`protected void`	`initFromParts(java.lang.String[] parts)`
`ClasspathElement[]`	`invalidElements()` Returns the classpath elements that are invalid.
`void`	`removeDuplicates()` Removes all duplicates of classpath elements that are already in the classpath.
`protected void`	`setElements(java.util.List<ClasspathElement> newValue)`
`protected StringUtil`	`str()`
`java.lang.String`	`toString()` Returns the string representation of this classpath using the current platform's path separator.
`java.lang.String`	`toString(java.lang.String separator)` Returns the string representation of this classpath using the given path separator.
`ClasspathElement[]`	`validElements()` Returns the classpath elements that are valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SEPARATOR
```
protected static final java.lang.String DEFAULT_SEPARATOR
```
- Constructor Detail
  - Classpath
```
public Classpath()
```
    Initialize the new instance with the classpath from System property "java.class.path" or from the Class-Path value in the manifest file of the sole JAR file if the program was started with option -jar.
  - Classpath
```
public Classpath(java.lang.String classpath)
```
    Initialize the new instance with a classpath definition.
    
    Parameters:
    
    classpath - A classpath definition with the current platform's path separator
  - Classpath
```
public Classpath(java.lang.String classpath,
                 java.lang.String separator)
```
    Initialize the new instance with a classpath definition where the separator is the one given as parameter.
    
    Parameters:
    
    classpath - A classpath definition with the specified path separator
    
    separator - The separator thst is used to separate the elements
  - Classpath
```
public Classpath(java.lang.String[] classpathElements)
```
    Initialize the new instance with the given elements.
    
    Parameters:
    
    classpathElements - An array with the elements of the classpath
  - Classpath
```
public Classpath(java.util.Collection<java.lang.String> classpathElements)
```
    Initialize the new instance with the given elements.
    
    Parameters:
    
    classpathElements - A collection of String elements that build the classpath.
- Method Detail
  - create
```
public static Classpath create(java.lang.String... classpathElements)
```
    Returns a new Classpath object initialized with the given path elemments. If the method is called with no parameter (i.e. an empty array), the default (system) classpath will be returned.
    
    Parameters:
    
    classpathElements - The arbitrary number of elements to be put into the classpath.
    
    Returns:
    
    A newly created Classpath instance.
  - allElements
```
public ClasspathElement[] allElements()
```
    Returns all classpath elements.
  - validElements
```
public ClasspathElement[] validElements()
```
    Returns the classpath elements that are valid.
  - invalidElements
```
public ClasspathElement[] invalidElements()
```
    Returns the classpath elements that are invalid.
  - elementsContaining
```
public ClasspathElement[] elementsContaining(java.lang.String filename)
```
    Returns all elements that contain a file with the specified name.
  - firstElementContaining
```
public ClasspathElement firstElementContaining(java.lang.String filename)
```
    Returns the first element that contains a file with the specified name or null if the file cannot be found.
  - removeDuplicates
```
public void removeDuplicates()
```
    Removes all duplicates of classpath elements that are already in the classpath.
  - toString
```
public java.lang.String toString()
```
    Returns the string representation of this classpath using the current platform's path separator.
    
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String separator)
```
    Returns the string representation of this classpath using the given path separator.
    
    Parameters:
    
    separator - The separator to separate the elements
  - init
```
protected void init(java.lang.String classpath,
                    java.lang.String separator)
```
  - initFromParts
```
protected void initFromParts(java.lang.String[] parts)
```
  - appendElement
```
protected void appendElement(java.lang.String elementName)
```
  - basicAppendElement
```
protected void basicAppendElement(java.lang.String elementName)
```
  - elementsWithFile
```
protected ClasspathElement[] elementsWithFile(java.lang.String filename)
```
    Returns all elements that contain a file with the given name.
  - elementsWithFile
```
protected ClasspathElement[] elementsWithFile(java.lang.String filename,
                                              boolean onlyFirst)
```
    Returns all elements or the first element that contain(s) a file with the given name.
  - collectElements
```
protected ClasspathElement[] collectElements(boolean valid)
```
  - elementArray
```
protected ClasspathElement[] elementArray(java.util.List<ClasspathElement> elementList)
```
  - getElements
```
protected java.util.List<ClasspathElement> getElements()
```
  - setElements
```
protected void setElements(java.util.List<ClasspathElement> newValue)
```
  - fileUtil
```
protected FileUtil fileUtil()
```
  - str
```
protected StringUtil str()
```

Class Classpath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SEPARATOR

Constructor Detail

Classpath

Classpath

Classpath

Classpath

Classpath

Method Detail

create

allElements

validElements

invalidElements

elementsContaining

firstElementContaining

removeDuplicates

toString

toString

init

initFromParts

appendElement

basicAppendElement

elementsWithFile

elementsWithFile

collectElements

elementArray

getElements

setElements

fileUtil

str