Package com.wavemaker.commons.io.store

Class StoredFile

java.lang.Object

com.wavemaker.commons.io.store.StoredResource

com.wavemaker.commons.io.store.StoredFile

All Implemented Interfaces:

File, Resource

Direct Known Subclasses:

LocalFile

public abstract class StoredFile
extends StoredResource
implements File

A File that is backed by a FileStore. Allows developers to use the simpler FileStore interface to provide a full File implementation. Subclasses must provide a suitable FileStore implementation via the getStore() method.

See Also:

FileStore, StoredFolder

Constructor Summary

Constructors

Constructor	Description
StoredFile()

Method Summary

Modifier and Type	Method	Description
File	copyTo(Folder folder)	Recursively copy this resource to the specified folder.
File	copyToIfNewer(Folder folder)	RCopy this file to the specified folder if this file is newer than the destination.
void	createIfMissing()	Recursively creates an empty representation of this resource and all parents.
void	delete()	Delete the current resource (and any children).
FileContent	getContent()	Provides access to file content.
long	getLastModified()	Gets the time this resource object was last modified.
long	getSize()	Returns the size in bytes of the virtual file.
protected abstract FileStore	getStore()
File	moveTo(Folder folder)	Move this resource to the specified folder.
File	rename(java.lang.String name)	Rename the current resource.
void	touch()	Update the last modified timestamp of the file to now.
protected boolean	write(File file)	Called to write the contents of another file to this file.

Methods inherited from class com.wavemaker.commons.io.store.StoredResource

createParentIfMissing, ensureExists, equals, exists, getName, getParent, getPath, hashCode, isModifiedAfter, isModifiedAfter, isModifiedBefore, isModifiedBefore, isRelativeTo, performOperation, toString, toString, toStringRelativeTo

Methods inherited from class java.lang.Object

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

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

equals, exists, getName, getParent, isModifiedAfter, isModifiedAfter, isModifiedBefore, isModifiedBefore, isRelativeTo, performOperation, toString, toString, toStringRelativeTo

Constructor Detail

StoredFile

public StoredFile()

Method Detail

getStore

protected abstract FileStore getStore()

Specified by:

getStore in class StoredResource

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

Overrides:

getLastModified in class StoredResource

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

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

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

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

Overrides:

rename in class StoredResource

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

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

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

copyToIfNewer

public File copyToIfNewer(Folder folder)

Description copied from interface: File

RCopy this file to the specified folder if this file is newer than the destination.

Specified by:

copyToIfNewer in interface File

Parameters:

folder - the folder to copy the file to

Returns:

a new resource (the current resource will no longer exist

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

write

protected boolean write(File file)

Called to write the contents of another file to this file. This method is can optionally be implemented by subclasses to implement custom file copy strategies.

Parameters:

file - the file being written to this one

Returns:

if the write operation has been handled. Return false for standard stream based writes.