de.intarsys.tools.locator

Class CommonLocator

java.lang.Object

de.intarsys.tools.locator.CommonLocator

All Implemented Interfaces:

ISynchronizable, ILocator, Serializable

Direct Known Subclasses:

ByteArrayLocator, ClassLoaderResourceLocator, ClassResourceLocator, FileLocator, LocatorViewport, StreamLocator, StringLocator, TransientLocator, URLLocator, ZipFileLocator

public abstract class CommonLocator
extends Object
implements ILocator, Serializable

An abstract superclass for implementing ILocator.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommonLocator()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Delete the artifact referenced by this.
long	getLength() Returns the length of this data container or -1 if unknown
boolean	isReadOnly() true if the specified resource is read only.
void	rename(String newName) Rename the complete physical name to newName.
void	setReadOnly() Make the receiver read only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.intarsys.tools.locator.ILocator

exists, getChild, getFullName, getInputStream, getLocalName, getOutputStream, getParent, getRandomAccess, getReader, getReader, getType, getTypedName, getWriter, getWriter, isDirectory, listLocators, toURL

Methods inherited from interface de.intarsys.tools.component.ISynchronizable

isOutOfSynch, synch

Constructor Detail

CommonLocator

public CommonLocator()

Method Detail

delete

public void delete()
            throws IOException

Description copied from interface: ILocator

Delete the artifact referenced by this.

Specified by:

delete in interface ILocator

Throws:

IOException

getLength

public long getLength()
               throws IOException

Description copied from interface: ILocator

Returns the length of this data container or -1 if unknown

Specified by:

getLength in interface ILocator

Returns:

the length of this data container, measured in bytes.

Throws:

IOException - if an I/O error occurs.

isReadOnly

public boolean isReadOnly()

Description copied from interface: ILocator

true if the specified resource is read only.

Specified by:

isReadOnly in interface ILocator

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

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

setReadOnly

public void setReadOnly()

Description copied from interface: ILocator

Make the receiver read only. This is a one way switch only.

Specified by:

setReadOnly in interface ILocator