Package com.wavemaker.commons.io.store

Class StoredFolder

java.lang.Object

com.wavemaker.commons.io.store.StoredResource

com.wavemaker.commons.io.store.StoredFolder

All Implemented Interfaces:

Folder, Resource, java.lang.Iterable<Resource>

Direct Known Subclasses:

LocalFolder, ZipArchive

public abstract class StoredFolder
extends StoredResource
implements Folder

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

See Also:

FolderStore, StoredFile

Constructor Summary

Constructors

Constructor	Description
StoredFolder()

Method Summary

Modifier and Type	Method	Description
Resources<Resource>	copyContentsTo(Folder folder)	Convenience methods to move the contents of the folder.
Folder	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).
Resources<Resource>	find()	Recursively find all immediate and nested children of this folder.
<T extends Resource> T	get(java.lang.String name, java.lang.Class<T> resourceType)	Get a child file or folder of the current folder.
Resource	getExisting(java.lang.String name)	Return a child from the current folder that refers to an existing File or Folder.
File	getFile(java.lang.String name)	Get a child file of the current folder.
Folder	getFolder(java.lang.String name)	Get a child folder of the current folder.
protected abstract FolderStore	getStore()
boolean	hasExisting(java.lang.String name)	Returns true if this folder already contains a resource with the specified name.
java.util.Iterator<Resource>	iterator()
Folder	jail()	Return a new folder that is jailed at the current location.
Resources<Resource>	list()	List all immediate child resources of this folder.
Resources<Resource>	moveContentsTo(Folder folder)	Convenience methods to move the contents of the folder.
Folder	moveTo(Folder folder)	Move this resource to the specified folder.
Folder	rename(java.lang.String name)	Rename the current resource.
java.lang.String	toString(ResourceStringFormat format)	Returns the name of the resource in the specified format.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

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

Constructor Detail

StoredFolder

public StoredFolder()

Method Detail

getStore

protected abstract FolderStore getStore()

Specified by:

getStore in class StoredResource

getExisting

public Resource getExisting(java.lang.String name)

Description copied from interface: Folder

Return a child from the current folder that refers to an existing File or Folder. If the name includes '/' characters then the file will be returned from nested folders. Paths are relative unless they begin with '/', in which case they are taken from the topmost parent. Use '..' to refer to a parent folder.

Specified by:

getExisting in interface Folder

Parameters:

name - the name of the resource

Returns:

a File or Folder resource

See Also:

Folder.hasExisting(String)

hasExisting

public boolean hasExisting(java.lang.String name)

Description copied from interface: Folder

Returns true if this folder already contains a resource with the specified name. This method supports the same naming rules as Folder.getExisting(String).

Specified by:

hasExisting in interface Folder

Parameters:

name - the name of the resource

Returns:

true if the resource is contained in the folder

See Also:

Folder.getExisting(String)

getFolder

public Folder getFolder(java.lang.String name)

Description copied from interface: Folder

Get a child folder of the current folder. This method supports the same naming rules as Folder.getExisting(String).

Specified by:

getFolder in interface Folder

Parameters:

name - the name of the folder to get

Returns:

the Folder

getFile

public File getFile(java.lang.String name)

Description copied from interface: Folder

Get a child file of the current folder. This method supports the same naming rules as Folder.getExisting(String).

Specified by:

getFile in interface Folder

Parameters:

name - the name of the file to get

Returns:

the File

get

public <T extends Resource> T get(java.lang.String name,
                                  java.lang.Class<T> resourceType)

Description copied from interface: Folder

Get a child file or folder of the current folder. Depending on the resourceType Folder.getFile(String) , Folder.getFolder(String) or Folder.getExisting(String) will be called. This method supports the same naming rules as Folder.getExisting(String).

Specified by:

get in interface Folder

Parameters:

name - the name of the resource to get

resourceType - the resource type

Returns:

the resource.

iterator

public java.util.Iterator<Resource> iterator()

Specified by:

iterator in interface java.lang.Iterable<Resource>

list

public Resources<Resource> list()

Description copied from interface: Folder

List all immediate child resources of this folder. If this resource does not exist empty resources are returned.

Specified by:

list in interface Folder

Returns:

a list of all immediate child resources

find

public Resources<Resource> find()

Description copied from interface: Folder

Recursively find all immediate and nested children of this folder. If this resource does not exist empty resources are returned.

Specified by:

find in interface Folder

Returns:

a list of all nested children

copyTo

public Folder 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 Folder

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

copyContentsTo

public Resources<Resource> copyContentsTo(Folder folder)

Description copied from interface: Folder

Convenience methods to move the contents of the folder. Equivalent to Folder.list(). copyTo(folder).

Specified by:

copyContentsTo in interface Folder

Parameters:

folder - the folder to copy the resource to

Returns:

a resource collection containing the new destination resources

See Also:

Resources.copyTo(Folder)

moveTo

public Folder 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 Folder

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

moveContentsTo

public Resources<Resource> moveContentsTo(Folder folder)

Description copied from interface: Folder

Convenience methods to move the contents of the folder. Equivalent to Folder.list(). moveTo(folder).

Specified by:

moveContentsTo in interface Folder

Parameters:

folder - the folder to move the resource to

Returns:

a resource collection containing the new destination resources

See Also:

Resources.moveTo(Folder)

rename

public Folder 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 Folder

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

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

jail

public Folder jail()

Description copied from interface: Folder

Return a new folder that is jailed at the current location. A jailed folder acts as a root folder at the current location.

Specified by:

jail in interface Folder

Returns:

a new jailed folder

toString

public java.lang.String toString(ResourceStringFormat format)

Description copied from interface: Resource

Returns the name of the resource in the specified format.

Specified by:

toString in interface Resource

Overrides:

toString in class StoredResource

Parameters:

format - the format used for the name

Returns:

the name

See Also:

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