de.intarsys.tools.locator
Class FileLocator

java.lang.Object
  de.intarsys.tools.locator.CommonLocator
      de.intarsys.tools.locator.FileLocator

All Implemented Interfaces:

de.intarsys.tools.component.ISynchronizable, ILocator

public class FileLocator
extends CommonLocator

File based implementation of ILocator.

Constructor Summary

FileLocator(File file)

FileLocator(String path)

Method Summary

void	delete() Delete the artifact referenced by this.
boolean	equals(Object obj)
boolean	exists() Answer true if the location designated by this exists.
File	getCanonicalFile() The canonical file represented by this.
ILocator	getChild(String name) The locator for the resource name within the context of this.
File	getFile() Answer the file represented by this.
String	getFullName() The full physical name of this.
InputStream	getInputStream() Return an InputStream on the data represented by the receiver.
String	getLocalName() The local name of the receiver within its parent.
OutputStream	getOutputStream() Return an OutputStream on the location represented by the receiver.
ILocator	getParent() The ILocator that is one hierarchy level up or null.
IRandomAccess	getRandomAccess() The IRandomAccess for this.
Reader	getReader() A Reader on the data represented by the receiver.
Reader	getReader(String newEncoding) A Reader on the data represented by the receiver for the given encoding.
String	getType() The type of the resource.
String	getTypedName() The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.
Writer	getWriter() A Writer on the location represented by the receiver.
Writer	getWriter(String newEncoding) A Writer on the location represented by the receiver for the given encoding.
int	hashCode()
boolean	isDirectory() Answer true if the location designated by this is a directory.
boolean	isOutOfSynch()
boolean	isReadOnly() true if the specified resource is read only.
boolean	isSynchSynchronous()
boolean	isUseTempFile() true if temp file should be used.
ILocator[]	listLocators(ILocatorNameFilter filter) Return an array of ILocator that are children of the receiver that conform to filter.
void	rename(String newName) Rename the complete physical name to newName.
void	setSynchSynchronous(boolean synchSynchronous)
void	setUseTempFile(boolean useTempFile)
void	synch()
String	toString()
URL	toURL() The location designated by this as an URL.

Methods inherited from class de.intarsys.tools.locator.CommonLocator

setReadOnly

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileLocator

public FileLocator(File file)

FileLocator

public FileLocator(String path)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

exists

public boolean exists()

Description copied from interface: ILocator

Answer true if the location designated by this exists.

Returns:

Answer true if the location designated by this exists.

getCanonicalFile

public File getCanonicalFile()

The canonical file represented by this.

Returns:

The canonical file represented by this.

getChild

public ILocator getChild(String name)

Description copied from interface: ILocator

The locator for the resource name within the context of this. This may for example be an ILocator to a file within a directory.

Parameters:

name - The name of the resource to be located.

Returns:

The ILocator for the resource with the name "name" within the context of this.

getFile

public File getFile()

Answer the file represented by this.

Returns:

The canonical file represented by this.

getFullName

public String getFullName()

Description copied from interface: ILocator

The full physical name of this.

This method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.

Returns:

The full physical name of the receiver.

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: ILocator

Return an InputStream on the data represented by the receiver.

Returns:

An InputStream on the data represented by the receiver.

Throws:

IOException

getLocalName

public String getLocalName()

Description copied from interface: ILocator

The local name of the receiver within its parent.

Returns:

The local name of the receiver within its parent.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: ILocator

Return an OutputStream on the location represented by the receiver.

Returns:

An OutputStream on the location represented by the receiver.

Throws:

IOException

getParent

public ILocator getParent()

Description copied from interface: ILocator

The ILocator that is one hierarchy level up or null. This may be for example the directory where the currently designated resource is found.

Returns:

The ILocatorthat is one hierarchy level up or null.

getRandomAccess

public IRandomAccess getRandomAccess()
                              throws IOException

Description copied from interface: ILocator

The IRandomAccess for this.

Returns:

The IRandomAccess for this.

Throws:

IOException

getReader

public Reader getReader()
                 throws IOException

Description copied from interface: ILocator

A Reader on the data represented by the receiver.

Returns:

A Reader on the data represented by the receiver.

Throws:

IOException

getReader

public Reader getReader(String newEncoding)
                 throws IOException

Description copied from interface: ILocator

A Reader on the data represented by the receiver for the given encoding.

Parameters:

newEncoding - The encoding.

Returns:

A Reader on the data represented by the receiver for the given encoding.

Throws:

IOException

getType

public String getType()

Description copied from interface: ILocator

The type of the resource. This may be for example a mime type or the file extension of the underlying file.

Returns:

The type of the resource

getTypedName

public String getTypedName()

Description copied from interface: ILocator

The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate. This is for example a filename with its correct suffix. Some locator may return the same name as "getLocalName".

Returns:

The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.

getWriter

public Writer getWriter()
                 throws IOException

Description copied from interface: ILocator

A Writer on the location represented by the receiver.

Returns:

A Writer on the location represented by the receiver.

Throws:

IOException

getWriter

public Writer getWriter(String newEncoding)
                 throws IOException

Description copied from interface: ILocator

A Writer on the location represented by the receiver for the given encoding.

Parameters:

newEncoding - The encoding.

Returns:

A Writer on the location represented by the receiver for the given encoding.

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDirectory

public boolean isDirectory()

Description copied from interface: ILocator

Answer true if the location designated by this is a directory. A directory location serves as a container for other resources, you can never getInputStream on this.

Returns:

Answer true if the location designated by this is a directory.

isOutOfSynch

public boolean isOutOfSynch()

isSynchSynchronous

public boolean isSynchSynchronous()

isUseTempFile

public boolean isUseTempFile()

true if temp file should be used.

Returns:

true if temp file should be used.

listLocators

public ILocator[] listLocators(ILocatorNameFilter filter)
                        throws IOException

Description copied from interface: ILocator

Return an array of ILocator that are children of the receiver that conform to filter. This method never returns null.

Parameters:

filter - The filter used to examine the child resources.

Returns:

An array of ILocator objects that conform to the filter argument.

Throws:

IOException

setSynchSynchronous

public void setSynchSynchronous(boolean synchSynchronous)

Parameters:

synchSynchronous -

setUseTempFile

public void setUseTempFile(boolean useTempFile)

Parameters:

useTempFile -

synch

public void synch()

toString

public String toString()

Overrides:

toString in class Object

toURL

public URL toURL()

Description copied from interface: ILocator

The location designated by this as an URL.

Returns:

The location designated by this as an URL.

isReadOnly

public boolean isReadOnly()

Description copied from interface: ILocator

true if the specified resource is read only.

Specified by:

isReadOnly in interface ILocator

Overrides:

isReadOnly in class CommonLocator

Returns:

true if the specified resource is read only.

rename

public void rename(String newName)
            throws IOException

Description copied from interface: ILocator

Rename the complete physical name to newName.

Specified by:

rename in interface ILocator

Overrides:

rename in class CommonLocator

Parameters:

newName - The new name of the ILocator. The new name is expected to contain both local and type part of the name.

Throws:

IOException

delete

public void delete()
            throws IOException

Description copied from interface: ILocator

Delete the artifact referenced by this.

Specified by:

delete in interface ILocator

Overrides:

delete in class CommonLocator

Throws:

IOException