Package com.wavemaker.commons.io

Class AbstractReadOnlyFile

java.lang.Object

com.wavemaker.commons.io.AbstractReadOnlyFile

All Implemented Interfaces:

File, Resource

Direct Known Subclasses:

ClassPathFile

public abstract class AbstractReadOnlyFile
extends java.lang.Object
implements File

Abstract base class for read-only File implementations that are not contained in any parent Folder.

Constructor Summary

Constructors

Constructor	Description
AbstractReadOnlyFile()

Method Summary

Modifier and Type	Method	Description
File	copyTo(Folder folder)	Recursively copy this resource to the specified folder.
void	createIfMissing()	Recursively creates an empty representation of this resource and all parents.
void	delete()	Delete the current resource (and any children).
boolean	equals(java.lang.Object obj)	Determines if this resource is equal to another object.
boolean	exists()	Returns true if the resource exists in the underlying store.
FileContent	getContent()	Provides access to file content.
protected abstract java.io.InputStream	getInputStream()	Return the input stream for the contents of the File or null if the file does not exist.
long	getLastModified()	Gets the time this resource object was last modified.
Folder	getParent()	Returns the parent folder of the resource or null if this is the root folder.
long	getSize()	Returns the size in bytes of the virtual file.
int	hashCode()
File	moveTo(Folder folder)	Move this resource to the specified folder.
protected ReadOnlyResourceException	newReadOnlyResourceException()	Return the ReadOnlyResourceException that should be thrown on error.
<R extends Resource,O extends ResourceOperation<R>> O	performOperation(O operation)
File	rename(java.lang.String name)	Rename the current resource.
java.lang.String	toString()	Returns the complete name of the resource.
void	touch()	Update the last modified timestamp of the file to now.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.wavemaker.commons.io.File

copyToIfNewer

Methods inherited from interface com.wavemaker.commons.io.Resource

getName, isModifiedAfter, isModifiedAfter, isModifiedBefore, isModifiedBefore, isRelativeTo, toString, toStringRelativeTo

Constructor Detail

AbstractReadOnlyFile

public AbstractReadOnlyFile()

Method Detail

getParent

public Folder getParent()

Description copied from interface: Resource

Returns the parent folder of the resource or null if this is the root folder.

Specified by:

getParent in interface Resource

Returns:

the parent folder or null

delete

public void delete()

Description copied from interface: Resource

Delete the current resource (and any children). If this resource does not exist then no operation is performed.

Specified by:

delete in interface Resource

exists

public boolean exists()

Description copied from interface: Resource

Returns true if the resource exists in the underlying store.

Specified by:

exists in interface Resource

Returns:

true if the resource exists.

createIfMissing

public void createIfMissing()

Description copied from interface: Resource

Recursively creates an empty representation of this resource and all parents. Calling this method on an existing resource has not effect.

Specified by:

createIfMissing in interface Resource

toString

public java.lang.String toString()

Description copied from interface: Resource

Returns the complete name of the resource. This name includes path elements. Folders always end in '/'.

Specified by:

toString in interface Resource

Overrides:

toString in class java.lang.Object

Returns:

the full name of the resource, for example "/folder/file.txt" or "/folder/"

See Also:

Resource.getName(), Resource.toString(ResourceStringFormat), Resource.toStringRelativeTo(Folder)

moveTo

public File moveTo(Folder folder)

Description copied from interface: Resource

Move this resource to the specified folder. Any duplicate Files will be replaced (existing Folder resources will be merged). If the resource does not exist a ResourceDoesNotExistException is thrown.

Specified by:

moveTo in interface File

Specified by:

moveTo in interface Resource

Parameters:

folder - the folder to move the resource to

Returns:

a new resource (the current resource will no longer exist

copyTo

public File copyTo(Folder folder)

Description copied from interface: Resource

Recursively copy this resource to the specified folder. Any duplicate Files will be replaced (existing Folder resources will be merged). If the resource does not exist a ResourceDoesNotExistException is thrown.

Specified by:

copyTo in interface File

Specified by:

copyTo in interface Resource

Parameters:

folder - the folder to copy the resource to

Returns:

a new resource (the current resource will no longer exist

rename

public File rename(java.lang.String name)

Description copied from interface: Resource

Rename the current resource. The rename operation cannot be used not move the resource to a different folder, use the Resource.moveTo(Folder) method to move the resource before renaming if required. Root folders cannot be renamed. If the resource does not exist a ResourceDoesNotExistException is thrown.

Specified by:

rename in interface File

Specified by:

rename in interface Resource

Parameters:

name - the new name of the resource (this must not include any path elements)

Returns:

a new resource (the current resource will no longer exist

touch

public void touch()

Description copied from interface: File

Update the last modified timestamp of the file to now.

Specified by:

touch in interface File

getSize

public long getSize()

Description copied from interface: File

Returns the size in bytes of the virtual file.

Specified by:

getSize in interface File

Returns:

the size in bytes

getLastModified

public long getLastModified()

Description copied from interface: Resource

Gets the time this resource object was last modified. The time is measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).

Specified by:

getLastModified in interface Resource

Returns:

the time this resource object was last modified; or 0 if the resource object does not exist, if an I/O error occurred, or if the operation is not supported

getContent

public FileContent getContent()

Description copied from interface: File

Provides access to file content. Calling any method on a file that does not exist will cause it to be created.

Specified by:

getContent in interface File

Returns:

the file content

performOperation

public <R extends Resource,O extends ResourceOperation<R>> O performOperation(O operation)

Specified by:

performOperation in interface Resource

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Resource

Determines if this resource is equal to another object. Any resources that have the same type, path and are stored in the same underlying system are considered equal.

Specified by:

equals in interface Resource

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to

Returns:

true if the resource is equal to the specified object.

getInputStream

protected abstract java.io.InputStream getInputStream()

Return the input stream for the contents of the File or null if the file does not exist.

Returns:

the InputStream or null

newReadOnlyResourceException

protected ReadOnlyResourceException newReadOnlyResourceException()

Return the ReadOnlyResourceException that should be thrown on error.

Returns:

the exception