FileLocator (PF-All 7.4.0 API)

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

All Implemented Interfaces:

IReleasable
```
public class FileLocator
extends java.lang.Object
implements IReleasable
```
This class mainly supports access to files which can be in the normal file directory structure or inside zip archives. The main purpose is to provide methods that transparently treat files the same way whether they are in the normal directory structure or inside archives. The syntax is simply to allow archive names in a path name at any place where a sub-directory name can be.
Examples:
- d:\temp\archive.zip\config\nls.properties
- /usr/java/jdk1.3/src.jar/java/io/File.java
- jar:http://myserver.com/code/src.jar!/settings.properties

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String TEMP_FILE_PREFIX

static java.lang.String TEMP_FILE_SUFFIX

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`TEMP_FILE_PREFIX`
`static java.lang.String`	`TEMP_FILE_SUFFIX`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.zip.ZipFile`	`archive()` Returns the file this locator presents as opened zip file or null in any case of error.
`protected java.util.zip.ZipEntry`	`archiveEntry()`
`protected java.lang.String`	`asRootPart(java.lang.String part)`
`protected void`	`closeZipFile()`
`protected java.util.zip.ZipFile`	`container()` Returns the zip file which is presented by the parent container or null in any case of error.
`protected java.io.File`	`convertFromURLSyntax(java.io.File aFile)`
`protected void`	`copyFromRemote()` This method must only be called if the original filename contains a URL starting with one of the supported remote protocols!
`static FileLocator`	`create(java.io.File file)` Create a file locator that corresponds to the given file name.
`static FileLocator`	`create(java.lang.String filename)` Create a file locator that corresponds to the given file name.
`static FileLocator`	`create(java.net.URL url)` Create a file locator that corresponds to the given URL.
`static FileLocator`	`createExtractedFile(FileLocator parent, java.lang.String zipEntryName, java.io.File extractedFile)` Create a file locator that represents an already extracted file from inside an archive.
`protected FileLocator`	`createFrom(java.io.File filePath)`
`protected FileLocator`	`createFrom(FileLocator aParent, java.lang.String[] pathElements)`
`protected boolean`	`doesElementExist(java.io.File element)`
`protected boolean`	`doesElementExistInArchive(java.lang.String elementName)`
`protected void`	`doesNotExist(java.io.File aFile)`
`protected java.util.zip.ZipEntry`	`entryFromArchive(java.lang.String elementName)`
`java.lang.Exception`	`exception()` Returns the last exception that occured while using this locator or null, if no exception was thrown at all.
`boolean`	`exists()` Returns whether or not the file specified by this locator exists.
`protected java.io.File`	`fileRef()` This either returns the underlying file from the local file system or unzipps the file from the underlying archive into a temporary file and returns
`protected static FileUtil`	`fileUtil()`
`protected java.io.File`	`fullFilePath(boolean absolute)`
`java.lang.String`	`getAbsolutePath()` Returns the full absolute pathname.
`protected java.lang.Exception`	`getException()`
`protected java.lang.Boolean`	`getExists()`
`protected java.io.File`	`getFile()`
`java.io.InputStream`	`getInputStream()` Returns an opened input stream on the file defined by this locator.
`protected java.lang.String`	`getNormalizedFilePath()`
`java.lang.String`	`getOriginalFileName()` Returns the original (unchanged) filename as it was given to the create method of this locator.
`FileLocator`	`getParent()` Returns the parent of the file represented by this locator
`protected FileLocator`	`getParentLocator()`
`java.lang.String`	`getPath()` Returns the full pathname.
`protected boolean`	`getRemote()`
`java.lang.String`	`getStandardizedAbsolutePath()` Returns the full absolute pathname in a standardized form.
`java.lang.String`	`getStandardizedPath()` Returns the full pathname in a standardized for.
`protected java.io.File`	`getTempFile()`
`protected java.io.File`	`getUnderlyingRealFile()` This either returns the underlying file from the local file system or unzipps the file from the underlying archive into a temporary file and returns In any case of error null wil be returned.
`protected java.util.zip.ZipFile`	`getZipFile()`
`protected void`	`handleException(java.lang.Exception ex)`
`protected FileLocator`	`initFromPath(java.lang.String[] parts, boolean startsFromRoot)`
`boolean`	`isDirectory()` Returns whether or not the name specified by this locator points to a directory.
`protected boolean`	`isDirectoryElement(java.io.File element)`
`protected boolean`	`isDirectoryInArchive(java.lang.String elementName)`
`boolean`	`isFile()` Returns whether or not the name specified by this locator points to a file.
`protected boolean`	`isFileElement(java.io.File element)`
`protected boolean`	`isFileInArchive(java.lang.String elementName)`
`boolean`	`isInArchive()` Returns whether or not the file specified by this locator is inside an archive.
`boolean`	`isRemote()` Returns true if the locator points to a remote file or directory.
`protected boolean`	`isResolved()`
`boolean`	`isTempFile()` Returns true if the underlying file has been resolved and copied to a temporary file in the local file system.
`protected boolean`	`isUnlocatedRemoteFile()`
`long`	`lastModified()` Returns the timestamp of when the file was last modified or 0 in any case of error.
`protected Logger`	`logger()`
`java.io.File`	`realFile()` Returns the file that contains the data the locator points to.
`void`	`release()` Releases any allocated objects (e.g.
`protected boolean`	`resolveIfNecessary()` Checks if the referred file has already been resolved.
`protected void`	`setException(java.lang.Exception newValue)`
`protected void`	`setExists(java.lang.Boolean newValue)`
`protected void`	`setFile(java.io.File newValue)`
`protected void`	`setIsResolved(boolean resolved)`
`protected void`	`setOriginalFileName(java.lang.String newValue)`
`protected void`	`setParentLocator(FileLocator newValue)`
`protected void`	`setRemote(boolean newValue)`
`protected void`	`setResolvedAsTempFile(java.io.File temporaryFile)`
`protected void`	`setTempFile(java.io.File aFile)`
`protected void`	`setZipFile(java.util.zip.ZipFile newValue)`
`long`	`size()` Returns the size of the file or 0 if it does not exist.
`protected static StringUtil`	`str()`
`java.lang.String`	`toString()`
`java.net.URL`	`toURL()` Returns the name of the file as an URL.
`protected void`	`urlPath(java.lang.StringBuffer buffer)`
`protected static boolean`	`usesSupportedRemoteProtocol(java.lang.String filename)`

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

- Field Detail
  - TEMP_FILE_PREFIX
```
public static final java.lang.String TEMP_FILE_PREFIX
```
    See Also:
    
    Constant Field Values
  - TEMP_FILE_SUFFIX
```
public static final java.lang.String TEMP_FILE_SUFFIX
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
public static FileLocator create(java.io.File file)
```
    Create a file locator that corresponds to the given file name.
  - create
```
public static FileLocator create(java.net.URL url)
```
    Create a file locator that corresponds to the given URL. Allowed remote URLs start with either "http://" or "https://" or "jar:http://" or "jar:https://".
    
    Parameters:
    
    url - The url that specifies the file
  - create
```
public static FileLocator create(java.lang.String filename)
```
    Create a file locator that corresponds to the given file name. Remote files are also supported for filenames starting with "http://" or "https://".
    
    Parameters:
    
    filename - The name (or URL) that specifies the file
  - createExtractedFile
```
public static FileLocator createExtractedFile(FileLocator parent,
                                              java.lang.String zipEntryName,
                                              java.io.File extractedFile)
```
    Create a file locator that represents an already extracted file from inside an archive.
    
    Parameters:
    
    parent - The file locator that represents the parent archive (must not be null).
    
    zipEntryName - The full name of the entry in the zip archive (must not be null.
    
    extractedFile - The file that has been extracted from the parent archive (must not be null).
    
    Returns:
    
    The new locator.
  - usesSupportedRemoteProtocol
```
protected static boolean usesSupportedRemoteProtocol(java.lang.String filename)
```
  - str
```
protected static StringUtil str()
```
  - fileUtil
```
protected static FileUtil fileUtil()
```
  - realFile
```
public java.io.File realFile()
```
    Returns the file that contains the data the locator points to. If the locator points to a normal file in a directory, than this file will be returned. If the locator points to a file inside an archive, the file will be unzipped into the tmp directory and this temp file will be returned. If the locator points to a remote file it will be downloaded to the temp directory and this temp file will be returned. If the locator points to a none existing file, this method returns null.
  - resolveIfNecessary
```
protected boolean resolveIfNecessary()
```
    Checks if the referred file has already been resolved. If not it tries to resolve it. That includes unzipping from archive as well as download of remote file.
    
    Returns:
    
    true if file is already or just has been resolved, otherwise false.
  - exists
```
public boolean exists()
```
    Returns whether or not the file specified by this locator exists. If the locator points to a remote file, it will be downloaded when calling this method.
  - isFile
```
public boolean isFile()
```
    Returns whether or not the name specified by this locator points to a file.
  - isDirectory
```
public boolean isDirectory()
```
    Returns whether or not the name specified by this locator points to a directory.
  - isRemote
```
public boolean isRemote()
```
    Returns true if the locator points to a remote file or directory.
  - isTempFile
```
public boolean isTempFile()
```
    Returns true if the underlying file has been resolved and copied to a temporary file in the local file system.
  - size
```
public long size()
```
    Returns the size of the file or 0 if it does not exist.
  - lastModified
```
public long lastModified()
```
    Returns the timestamp of when the file was last modified or 0 in any case of error.
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Returns an opened input stream on the file defined by this locator.
    
    Throws:
    
    java.io.IOException
  - getParent
```
public FileLocator getParent()
```
    Returns the parent of the file represented by this locator
  - isInArchive
```
public boolean isInArchive()
```
    Returns whether or not the file specified by this locator is inside an archive.
  - getPath
```
public java.lang.String getPath()
```
    Returns the full pathname.
  - getAbsolutePath
```
public java.lang.String getAbsolutePath()
```
    Returns the full absolute pathname.
  - getStandardizedPath
```
public java.lang.String getStandardizedPath()
```
    Returns the full pathname in a standardized for. That is all ".." and "." elements are removed and forward slashes are used as separators of the remaining elements.
  - getStandardizedAbsolutePath
```
public java.lang.String getStandardizedAbsolutePath()
```
    Returns the full absolute pathname in a standardized form. That is all ".." and "." elements are removed and forward slashes are used as separators of the remaining elements.
  - exception
```
public java.lang.Exception exception()
```
    Returns the last exception that occured while using this locator or null, if no exception was thrown at all.
  - toURL
```
public java.net.URL toURL()
                   throws java.net.MalformedURLException
```
    Returns the name of the file as an URL.
    
    Throws:
    
    java.net.MalformedURLException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - release
```
public void release()
```
    Releases any allocated objects (e.g. deleting temporary file).
    
    Specified by:
    
    release in interface IReleasable
  - getOriginalFileName
```
public java.lang.String getOriginalFileName()
```
    Returns the original (unchanged) filename as it was given to the create method of this locator.
  - createFrom
```
protected FileLocator createFrom(java.io.File filePath)
```
  - createFrom
```
protected FileLocator createFrom(FileLocator aParent,
                                 java.lang.String[] pathElements)
                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - initFromPath
```
protected FileLocator initFromPath(java.lang.String[] parts,
                                   boolean startsFromRoot)
                            throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - doesElementExist
```
protected boolean doesElementExist(java.io.File element)
                            throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - isFileElement
```
protected boolean isFileElement(java.io.File element)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - isDirectoryElement
```
protected boolean isDirectoryElement(java.io.File element)
                              throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - doesElementExistInArchive
```
protected boolean doesElementExistInArchive(java.lang.String elementName)
                                     throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - isFileInArchive
```
protected boolean isFileInArchive(java.lang.String elementName)
                           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - isDirectoryInArchive
```
protected boolean isDirectoryInArchive(java.lang.String elementName)
```
  - entryFromArchive
```
protected java.util.zip.ZipEntry entryFromArchive(java.lang.String elementName)
                                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - archiveEntry
```
protected java.util.zip.ZipEntry archiveEntry()
                                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - doesNotExist
```
protected void doesNotExist(java.io.File aFile)
```
  - fullFilePath
```
protected java.io.File fullFilePath(boolean absolute)
```
  - urlPath
```
protected void urlPath(java.lang.StringBuffer buffer)
```
  - getUnderlyingRealFile
```
protected java.io.File getUnderlyingRealFile()
```
    This either returns the underlying file from the local file system or unzipps the file from the underlying archive into a temporary file and returns In any case of error null wil be returned.
  - fileRef
```
protected java.io.File fileRef()
                        throws java.io.IOException
```
    This either returns the underlying file from the local file system or unzipps the file from the underlying archive into a temporary file and returns
    
    Throws:
    
    java.io.IOException
  - archive
```
protected java.util.zip.ZipFile archive()
                                 throws java.io.IOException
```
    Returns the file this locator presents as opened zip file or null in any case of error.
    
    Throws:
    
    java.io.IOException
  - container
```
protected java.util.zip.ZipFile container()
                                   throws java.io.IOException
```
    Returns the zip file which is presented by the parent container or null in any case of error.
    
    Throws:
    
    java.io.IOException
  - closeZipFile
```
protected void closeZipFile()
```
  - convertFromURLSyntax
```
protected java.io.File convertFromURLSyntax(java.io.File aFile)
```
  - getNormalizedFilePath
```
protected java.lang.String getNormalizedFilePath()
```
  - isUnlocatedRemoteFile
```
protected boolean isUnlocatedRemoteFile()
```
  - copyFromRemote
```
protected void copyFromRemote()
```
    This method must only be called if the original filename contains a URL starting with one of the supported remote protocols!
  - setResolvedAsTempFile
```
protected void setResolvedAsTempFile(java.io.File temporaryFile)
```
  - asRootPart
```
protected java.lang.String asRootPart(java.lang.String part)
```
  - setOriginalFileName
```
protected void setOriginalFileName(java.lang.String newValue)
```
  - getParentLocator
```
protected FileLocator getParentLocator()
```
  - setParentLocator
```
protected void setParentLocator(FileLocator newValue)
```
  - getFile
```
protected java.io.File getFile()
```
  - setFile
```
protected void setFile(java.io.File newValue)
```
  - getZipFile
```
protected java.util.zip.ZipFile getZipFile()
```
  - setZipFile
```
protected void setZipFile(java.util.zip.ZipFile newValue)
```
  - getExists
```
protected java.lang.Boolean getExists()
```
  - setExists
```
protected void setExists(java.lang.Boolean newValue)
```
  - getException
```
protected java.lang.Exception getException()
```
  - setException
```
protected void setException(java.lang.Exception newValue)
```
  - getRemote
```
protected boolean getRemote()
```
  - setRemote
```
protected void setRemote(boolean newValue)
```
  - getTempFile
```
protected java.io.File getTempFile()
```
  - setTempFile
```
protected void setTempFile(java.io.File aFile)
```
  - isResolved
```
protected boolean isResolved()
```
  - setIsResolved
```
protected void setIsResolved(boolean resolved)
```
  - handleException
```
protected void handleException(java.lang.Exception ex)
```
  - logger
```
protected Logger logger()
```

Class FileLocator

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEMP_FILE_PREFIX

TEMP_FILE_SUFFIX

Method Detail

create

create

create

createExtractedFile

usesSupportedRemoteProtocol

str

fileUtil

realFile

resolveIfNecessary

exists

isFile

isDirectory

isRemote

isTempFile

size

lastModified

getInputStream

getParent

isInArchive

getPath

getAbsolutePath

getStandardizedPath

getStandardizedAbsolutePath

exception

toURL

toString

release

getOriginalFileName

createFrom

createFrom

initFromPath

doesElementExist

isFileElement

isDirectoryElement

doesElementExistInArchive

isFileInArchive

isDirectoryInArchive

entryFromArchive

archiveEntry

doesNotExist

fullFilePath

urlPath

getUnderlyingRealFile

fileRef

archive

container

closeZipFile

convertFromURLSyntax

getNormalizedFilePath

isUnlocatedRemoteFile

copyFromRemote

setResolvedAsTempFile

asRootPart

setOriginalFileName

getParentLocator

setParentLocator

getFile

setFile

getZipFile

setZipFile

getExists

setExists

getException

setException

getRemote

setRemote

getTempFile

setTempFile

isResolved

setIsResolved

handleException

logger