ClasspathElement (PF-All 7.4.0 API)

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

```
public class ClasspathElement
extends java.lang.Object
```
Represents one entry in a classpath. It can be asked if it s a directory or an archive. It also can be asked if it exists and it is valid (really a zip archive).

Constructor Summary

Constructors
Constructor and Description
`ClasspathElement(java.io.File aFile)` Initialize the new instance with a file representing either a directory or an archive file.
`ClasspathElement(java.lang.String elementName)` Initialize the new instance with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`archiveContainsFile(java.lang.String filename)`
`protected boolean`	`checkArchive()`
`void`	`close()` Close any underlying (maybe) opened archive
`boolean`	`contains(java.lang.String filename)` Returns whether or not this element contains a file with the given name.
`java.net.URL`	`createURL(java.lang.String filename)` Creates a URL for the file with the given name that is in this file container.
`protected void`	`debug(java.lang.String text)`
`protected boolean`	`dirContainsFile(java.lang.String filename)`
`boolean`	`equals(java.lang.Object object)` Returns true if the given object is equal to this object
`boolean`	`exists()` Returns whether or not this classpath element exists.
`protected FileUtil`	`futil()`
`protected java.io.File`	`getFile()`
`protected java.util.zip.ZipEntry`	`getFileFromArchive(java.lang.String filename)`
`protected java.io.File`	`getFileFromDirectory(java.lang.String filename)`
`FileInfo`	`getFileInfo(java.lang.String filename)` Returns a file info object for the given filename which is expected to be inside the directory or archive represented by this classpath element.
`protected java.lang.String`	`getId()`
`java.lang.String`	`getName()` Returns the name of this classpath element
`java.net.URL`	`getURL()` Returns a URL that points to this classpath element.
`protected boolean`	`getValid()`
`protected java.util.zip.ZipFile`	`getZipFile()` Opens and returns the zip file.
`protected void`	`handleException(java.lang.Exception ex)`
`int`	`hashCode()` Returns the hash value of this object
`protected void`	`init(java.io.File aFile)`
`boolean`	`isArchive()` Returns true, if this element is an archive file.
`boolean`	`isDirectory()` Returns true, if this element is a directory
`boolean`	`isFile()` Returns true, if this element is a file.
`boolean`	`isOpen()` Returns true, if this element represents an archive (zip file) and that archive is currently open.
`boolean`	`isValid()` Returns true, if this element is either a valid directory or really an archive (zip file).
`boolean`	`leaveArchiveOpen()` Returns true, if an opened archive stays open until method close() gets called.
`void`	`leaveArchiveOpen(boolean newValue)` Sets whether an opened archive stays open until method close() gets called.
`protected Logger`	`logger()`
`java.io.InputStream`	`open(java.lang.String filename)` Opens the file with the given name in this classpath element and returns the input stream.
`protected void`	`setFile(java.io.File newValue)`
`protected void`	`setId(java.lang.String newValue)`
`protected void`	`setName(java.lang.String newValue)`
`protected void`	`setValid(boolean newValue)`
`protected void`	`setZipFile(java.util.zip.ZipFile newValue)`
`protected SysUtil`	`sys()`
`java.lang.String`	`toString()` Returns the element's string representation.

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

- Constructor Detail
  - ClasspathElement
```
public ClasspathElement(java.io.File aFile)
```
    Initialize the new instance with a file representing either a directory or an archive file.
    
    Parameters:
    
    aFile - A file representing an element in a classpath
  - ClasspathElement
```
public ClasspathElement(java.lang.String elementName)
```
    Initialize the new instance with default values.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this classpath element
  - leaveArchiveOpen
```
public boolean leaveArchiveOpen()
```
    Returns true, if an opened archive stays open until method close() gets called. Returns true if the archive gets closed after each access. The default is false.
    
    See Also:
    
    close()
  - leaveArchiveOpen
```
public void leaveArchiveOpen(boolean newValue)
```
    Sets whether an opened archive stays open until method close() gets called. If set to false the archive gets closed after each access.
    
    See Also:
    
    close()
  - exists
```
public boolean exists()
```
    Returns whether or not this classpath element exists.
  - isFile
```
public boolean isFile()
```
    Returns true, if this element is a file. Actually it only determines, if this element is a file. This doesn't ensure that it is really an archive file.
  - isArchive
```
public boolean isArchive()
```
    Returns true, if this element is an archive file.
  - isDirectory
```
public boolean isDirectory()
```
    Returns true, if this element is a directory
  - isValid
```
public boolean isValid()
```
    Returns true, if this element is either a valid directory or really an archive (zip file).
  - isOpen
```
public boolean isOpen()
```
    Returns true, if this element represents an archive (zip file) and that archive is currently open. If it represents a directory this method returns false
  - contains
```
public boolean contains(java.lang.String filename)
```
    Returns whether or not this element contains a file with the given name.
    
    Parameters:
    
    filename - The name of the file to be looked for
  - getFileInfo
```
public FileInfo getFileInfo(java.lang.String filename)
```
    Returns a file info object for the given filename which is expected to be inside the directory or archive represented by this classpath element.
    
    Parameters:
    
    filename - The name of the file to be looked for
    
    Returns:
    
    A file info object or null if the specified file does not exist
  - open
```
public java.io.InputStream open(java.lang.String filename)
                         throws java.io.IOException
```
    Opens the file with the given name in this classpath element and returns the input stream. If the file doesn't exist or this classpath element is not valid, null will be returned.
    
    Parameters:
    
    filename - The name of the file in this container to be opened
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
```
    Close any underlying (maybe) opened archive
  - getURL
```
public java.net.URL getURL()
```
    Returns a URL that points to this classpath element.
  - createURL
```
public java.net.URL createURL(java.lang.String filename)
```
    Creates a URL for the file with the given name that is in this file container. It is not checked, if the file really exists. If this classpath element is invalid null will be returned.
  - toString
```
public java.lang.String toString()
```
    Returns the element's string representation. The string always contains slashes, never backslashes.
    
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Returns the hash value of this object
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    
    Object.hashCode()
  - equals
```
public boolean equals(java.lang.Object object)
```
    Returns true if the given object is equal to this object
    
    Overrides:
    
    equals in class java.lang.Object
  - init
```
protected void init(java.io.File aFile)
```
  - checkArchive
```
protected boolean checkArchive()
```
  - dirContainsFile
```
protected boolean dirContainsFile(java.lang.String filename)
```
  - getFileFromDirectory
```
protected java.io.File getFileFromDirectory(java.lang.String filename)
```
  - archiveContainsFile
```
protected boolean archiveContainsFile(java.lang.String filename)
```
  - getFileFromArchive
```
protected java.util.zip.ZipEntry getFileFromArchive(java.lang.String filename)
```
  - getZipFile
```
protected java.util.zip.ZipFile getZipFile()
                                    throws java.util.zip.ZipException,
                                           java.io.IOException
```
    Opens and returns the zip file. The zip file stays open until close() is called explicitly.
    
    Throws:
    
    java.util.zip.ZipException
    
    java.io.IOException
    
    See Also:
    
    close()
  - handleException
```
protected void handleException(java.lang.Exception ex)
```
  - setName
```
protected void setName(java.lang.String newValue)
```
  - getFile
```
protected java.io.File getFile()
```
  - setFile
```
protected void setFile(java.io.File newValue)
```
  - getValid
```
protected boolean getValid()
```
  - setValid
```
protected void setValid(boolean newValue)
```
  - getId
```
protected java.lang.String getId()
```
  - setId
```
protected void setId(java.lang.String newValue)
```
  - setZipFile
```
protected void setZipFile(java.util.zip.ZipFile newValue)
```
  - debug
```
protected void debug(java.lang.String text)
```
  - logger
```
protected Logger logger()
```
  - futil
```
protected FileUtil futil()
```
  - sys
```
protected SysUtil sys()
```

Class ClasspathElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClasspathElement

ClasspathElement

Method Detail

getName

leaveArchiveOpen

leaveArchiveOpen

exists

isFile

isArchive

isDirectory

isValid

isOpen

contains

getFileInfo

open

close

getURL

createURL

toString

hashCode

equals

init

checkArchive

dirContainsFile

getFileFromDirectory

archiveContainsFile

getFileFromArchive

getZipFile

handleException

setName

getFile

setFile

getValid

setValid

getId

setId

setZipFile

debug

logger

futil

sys