org.jboss.forge.addon.resource

Interface ResourceFactory

public interface ResourceFactory

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.forge.furnace.spi.ListenerRegistration<ResourceTransactionListener>	addTransactionListener(ResourceTransactionListener listener) Add a ResourceTransactionListener to be notified when ResourceTransaction events occur.
<E,T extends Resource<E>> T	create(Class<T> type, E underlyingResource) Create a Resource of the given type, using the provided underlying resource instance.
<E> Resource<E>	create(E underlyingResource) Create a Resource to represent the provided underlying resource.
FileOperations	getFileOperations() Returns the operational layer for File objects.
ResourceTransaction	getTransaction() Get the transaction associated with this ResourceFactory in the calling thread
ResourceMonitor	monitor(Resource<?> resource) Monitors a specific resource for changes and fires the registered listeners
ResourceMonitor	monitor(Resource<?> resource, ResourceFilter resourceFilter) Monitors a specific resource for changes and fires the registered listeners given the specified filter

Method Detail

create

<E,T extends Resource<E>> T create(Class<T> type,
                                 E underlyingResource)

Create a Resource of the given type, using the provided underlying resource instance.

Returns:

null if no resource could be created for the given object.

create

<E> Resource<E> create(E underlyingResource)

Create a Resource to represent the provided underlying resource. The resource type will be detected automatically.

Returns:

null if no resource could be created for the given object.

monitor

ResourceMonitor monitor(Resource<?> resource)

Monitors a specific resource for changes and fires the registered listeners

Parameters:

resource - the resource to be monitored

Returns:

a ResourceMonitor for the specific resource

monitor

ResourceMonitor monitor(Resource<?> resource,
                      ResourceFilter resourceFilter)

Monitors a specific resource for changes and fires the registered listeners given the specified filter

Parameters:

resource - the resource to be monitored

resourceFilter - a filter for children of the specified resource

Returns:

a ResourceMonitor for the specific resource

getTransaction

ResourceTransaction getTransaction()

Get the transaction associated with this ResourceFactory in the calling thread

Returns:

the ResourceTransaction associated with this factory. Throws UnsupportedOperationException if the implementation does not support it.

getFileOperations

FileOperations getFileOperations()

Returns the operational layer for File objects. This object should be used if operations on a File should happen in a transactional context. The default implementation invokes the File methods where applicable

addTransactionListener

org.jboss.forge.furnace.spi.ListenerRegistration<ResourceTransactionListener> addTransactionListener(ResourceTransactionListener listener)

Add a ResourceTransactionListener to be notified when ResourceTransaction events occur.