Index (Forge - Resource Addon API 2.0.0.Alpha4 API)

A C D E F G H I L M O P R S T U V

A

AbstractFileResource<T extends FileResource<T>> - Class in org.jboss.forge.resource: A standard, built-in resource for representing files on the filesystem.
AbstractFileResource(ResourceFactory, File) - Constructor for class org.jboss.forge.resource.AbstractFileResource
AbstractResource<T> - Class in org.jboss.forge.resource
AbstractResource(ResourceFactory, Resource<?>) - Constructor for class org.jboss.forge.resource.AbstractResource
accept(Resource<?>) - Method in interface org.jboss.forge.resource.ResourceFilter

C

ChangeSet - Interface in org.jboss.forge.resource.transaction: A ChangeSet object contains the modified resources of a specific transaction
commit() - Method in interface org.jboss.forge.resource.transaction.ResourceTransaction: Attempt to commit this transaction, discarding the current ChangeSet.
create(Class<T>, E) - Method in interface org.jboss.forge.resource.ResourceFactory: Create a Resource of the given type, using the provided underlying resource instance.
create(E) - Method in interface org.jboss.forge.resource.ResourceFactory: Create a Resource to represent the provided underlying resource.
createFrom(File) - Method in class org.jboss.forge.resource.AbstractFileResource: Create a new Resource instance for the target file.
createFrom(T) - Method in interface org.jboss.forge.resource.Resource: Create a new resource instance for the target resource reference of the type that this current resource is.
createFrom(T) - Method in class org.jboss.forge.resource.VirtualResource
createNewFile() - Method in class org.jboss.forge.resource.AbstractFileResource: Create the file in the underlying resource system.
createNewFile() - Method in interface org.jboss.forge.resource.FileResource: Create the file in the underlying resource system.
createTempResource() - Method in class org.jboss.forge.resource.AbstractFileResource
createTempResource() - Method in interface org.jboss.forge.resource.FileResource: Create a temporary FileResource

D

delete() - Method in class org.jboss.forge.resource.AbstractFileResource: Delete this file, non-recursively.
delete(boolean) - Method in class org.jboss.forge.resource.AbstractFileResource: Delete this Resource, and all child resources.
delete() - Method in interface org.jboss.forge.resource.Resource: Delete this resource, return true if successful, false if not.
delete(boolean) - Method in interface org.jboss.forge.resource.Resource: Delete this resource, return true if successful, false if not.
deleteOnExit() - Method in class org.jboss.forge.resource.AbstractFileResource: Requests that the file or directory denoted by this resource be deleted when the virtual machine terminates.
deleteOnExit() - Method in interface org.jboss.forge.resource.FileResource: Requests that the file or directory denoted by this resource be deleted when the virtual machine terminates.
DirectoryResource - Interface in org.jboss.forge.resource: A standard, build-in, resource for representing directories on the file-system.
doListResources() - Method in class org.jboss.forge.resource.AbstractResource: Strategy method for returning child resources.

E

equals(Object) - Method in class org.jboss.forge.resource.AbstractResource
equals(Object) - Method in class org.jboss.forge.resource.events.ResourceEvent
equals(Object) - Method in class org.jboss.forge.resource.events.ResourceRenamed
exists() - Method in class org.jboss.forge.resource.AbstractFileResource
exists() - Method in interface org.jboss.forge.resource.Resource: Return true if this Resource exists, return false if not.
exists() - Method in class org.jboss.forge.resource.VirtualResource

F

file - Variable in class org.jboss.forge.resource.AbstractFileResource
FileResource<T extends FileResource<T>> - Interface in org.jboss.forge.resource: A standard, built-in resource for representing files on the filesystem.
fireEvent(ResourceEvent) - Method in interface org.jboss.forge.resource.ResourceFactory: Broadcast a ResourceEvent

G

getChangeSet() - Method in interface org.jboss.forge.resource.transaction.ResourceTransaction
getChild(String) - Method in class org.jboss.forge.resource.AbstractFileResource
getChild(String) - Method in interface org.jboss.forge.resource.Resource: Get a child of this resource.
getChild(String) - Method in class org.jboss.forge.resource.VirtualResource
getChildDirectory(String) - Method in interface org.jboss.forge.resource.DirectoryResource: Obtain a reference to the child DirectoryResource.
getChildOfType(Class<T>, String) - Method in interface org.jboss.forge.resource.DirectoryResource: Using the given type, obtain a reference to the child resource of the given type.
getCurrentTransaction() - Method in interface org.jboss.forge.resource.transaction.ResourceTransactionManager
getFullyQualifiedName() - Method in class org.jboss.forge.resource.AbstractResource
getFullyQualifiedName() - Method in interface org.jboss.forge.resource.Resource: Return the fully qualified name of the resource (if applicable).
getModifiedResources() - Method in interface org.jboss.forge.resource.transaction.ChangeSet
getName() - Method in class org.jboss.forge.resource.AbstractFileResource
getName() - Method in interface org.jboss.forge.resource.Resource: Return the common name of the resource.
getNewLocation() - Method in class org.jboss.forge.resource.events.ResourceRenamed
getOrCreateChildDirectory(String) - Method in interface org.jboss.forge.resource.DirectoryResource: Obtain a reference to the child DirectoryResource.
getOriginalLocation() - Method in class org.jboss.forge.resource.events.ResourceRenamed
getParent() - Method in class org.jboss.forge.resource.AbstractFileResource: Get the parent of the current resource.
getParent() - Method in class org.jboss.forge.resource.AbstractResource
getParent() - Method in interface org.jboss.forge.resource.FileResource: A parent for a FileResource is always a DirectoryResource
getParent() - Method in interface org.jboss.forge.resource.Resource: Get the parent of the current resource.
getResource() - Method in class org.jboss.forge.resource.events.ResourceEvent
getResource(ResourceFactory, Class<RESOURCETYPE>, UNDERLYINGTYPE) - Method in interface org.jboss.forge.resource.ResourceGenerator: Get an instance of a Resource to handle the given Class type and object instance.
getResourceFactory() - Method in class org.jboss.forge.resource.AbstractResource
getResourceFactory() - Method in interface org.jboss.forge.resource.Resource: Return the ResourceFactory with which this Resource was created.
getResourceInputStream() - Method in class org.jboss.forge.resource.AbstractFileResource
getResourceInputStream() - Method in interface org.jboss.forge.resource.Resource: Get the InputStream represented by this Resource.
getResourceInputStream() - Method in class org.jboss.forge.resource.VirtualResource
getResourceType(Class<RESOURCETYPE>, UNDERLYINGTYPE) - Method in interface org.jboss.forge.resource.ResourceGenerator: Get the Resource type that will be generated for the given Class type and object instance.
getSize() - Method in class org.jboss.forge.resource.AbstractFileResource
getSize() - Method in interface org.jboss.forge.resource.FileResource: Returns the size of the file denoted by this abstract pathname
getUnderlyingResourceObject() - Method in class org.jboss.forge.resource.AbstractFileResource: Get the actual underlying file resource that this resource instance represents, whether existing or non-existing.
getUnderlyingResourceObject() - Method in interface org.jboss.forge.resource.Resource: Get the underlying object represented by this Resource

H

handles(Class<?>, Object) - Method in interface org.jboss.forge.resource.ResourceGenerator: Returns true if the given object instance and Class type are handled by this ResourceGenerator
hashCode() - Method in class org.jboss.forge.resource.AbstractResource
hashCode() - Method in class org.jboss.forge.resource.events.ResourceEvent
hashCode() - Method in class org.jboss.forge.resource.events.ResourceRenamed

I

isDirectory() - Method in class org.jboss.forge.resource.AbstractFileResource: Return true if this AbstractFileResource exists and is actually a directory, otherwise return false;
isDirectory() - Method in interface org.jboss.forge.resource.FileResource: Return true if this FileResource exists and is actually a directory, otherwise return false;
isExecutable() - Method in class org.jboss.forge.resource.AbstractFileResource
isExecutable() - Method in interface org.jboss.forge.resource.FileResource: Returns if a file is executable
isReadable() - Method in class org.jboss.forge.resource.AbstractFileResource
isReadable() - Method in interface org.jboss.forge.resource.FileResource: Returns if a file is readable
isStale() - Method in class org.jboss.forge.resource.AbstractFileResource: Returns true if the underlying resource has been modified on the file system since it was initially loaded.
isStale() - Method in interface org.jboss.forge.resource.FileResource: Returns true if the underlying resource has been modified on the file system since it was initially loaded.
isWritable() - Method in class org.jboss.forge.resource.AbstractFileResource
isWritable() - Method in interface org.jboss.forge.resource.FileResource: Returns if a file is writable

L

lastModification - Variable in class org.jboss.forge.resource.AbstractFileResource
listResources() - Method in class org.jboss.forge.resource.AbstractResource
listResources(ResourceFilter) - Method in class org.jboss.forge.resource.AbstractResource
listResources() - Method in interface org.jboss.forge.resource.Resource: Return a list of child resources of the current resource.
listResources(ResourceFilter) - Method in interface org.jboss.forge.resource.Resource: Return a list of child resources of the current resource matching the given ResourceFilter.

M

markUpToDate() - Method in class org.jboss.forge.resource.AbstractFileResource: Re-read the last modified timestamp for this resource.
markUpToDate() - Method in interface org.jboss.forge.resource.FileResource: Re-read the last modified timestamp for this resource.
mkdir() - Method in class org.jboss.forge.resource.AbstractFileResource: Create a new single directory for this resource.
mkdir() - Method in interface org.jboss.forge.resource.FileResource: Create a new single directory for this resource.
mkdirs() - Method in class org.jboss.forge.resource.AbstractFileResource: Create all directories required for this resource to exist.
mkdirs() - Method in interface org.jboss.forge.resource.FileResource: Create all directories required for this resource to exist.

O

org.jboss.forge.resource - package org.jboss.forge.resource
org.jboss.forge.resource.events - package org.jboss.forge.resource.events
org.jboss.forge.resource.transaction - package org.jboss.forge.resource.transaction

P

parent - Variable in class org.jboss.forge.resource.AbstractResource

R

reify(Class<R>) - Method in class org.jboss.forge.resource.AbstractFileResource
reify(Class<R>) - Method in class org.jboss.forge.resource.AbstractResource
reify(Class<R>) - Method in interface org.jboss.forge.resource.Resource: Ask this Resource if it is actually a resource of the given type; if it is, return a new reference to the resource as the given type, otherwise return null.
renameTo(String) - Method in class org.jboss.forge.resource.AbstractFileResource: Rename this resource to the given path.
renameTo(FileResource<?>) - Method in class org.jboss.forge.resource.AbstractFileResource: Rename this resource to the given AbstractFileResource
renameTo(String) - Method in interface org.jboss.forge.resource.FileResource: Rename this Resource to the given path.
renameTo(FileResource<?>) - Method in interface org.jboss.forge.resource.FileResource: Rename this Resource to the given FileResource
Resource<T> - Interface in org.jboss.forge.resource: A Resource is an abstraction on top of usable items within a Forge project.
ResourceCreated - Class in org.jboss.forge.resource.events: Fired when a Resource has been created.
ResourceCreated(Resource<?>) - Constructor for class org.jboss.forge.resource.events.ResourceCreated
ResourceDeleted - Class in org.jboss.forge.resource.events: Fired when a Resource has been deleted.
ResourceDeleted(Resource<?>) - Constructor for class org.jboss.forge.resource.events.ResourceDeleted
ResourceEvent - Class in org.jboss.forge.resource.events
ResourceEvent(Resource<?>) - Constructor for class org.jboss.forge.resource.events.ResourceEvent
ResourceException - Exception in org.jboss.forge.resource: Represents a generic Exception thrown by the Forge Resource API
ResourceException() - Constructor for exception org.jboss.forge.resource.ResourceException
ResourceException(String, Throwable) - Constructor for exception org.jboss.forge.resource.ResourceException
ResourceException(String) - Constructor for exception org.jboss.forge.resource.ResourceException
ResourceException(Throwable) - Constructor for exception org.jboss.forge.resource.ResourceException
ResourceFacet - Interface in org.jboss.forge.resource: A Facet for use in Resource instances.
resourceFactory - Variable in class org.jboss.forge.resource.AbstractResource
ResourceFactory - Interface in org.jboss.forge.resource
ResourceFilter - Interface in org.jboss.forge.resource: Used to filter Resource instances during a given operation.
ResourceGenerator<RESOURCETYPE,UNDERLYINGTYPE> - Interface in org.jboss.forge.resource: Defines the mechanism for registering new Resource types.
ResourceModified - Class in org.jboss.forge.resource.events: Fired when a Resource has been modified.
ResourceModified(Resource<?>) - Constructor for class org.jboss.forge.resource.events.ResourceModified
ResourceRenamed - Class in org.jboss.forge.resource.events
ResourceRenamed(Resource<?>, String, String) - Constructor for class org.jboss.forge.resource.events.ResourceRenamed
ResourceTransaction - Interface in org.jboss.forge.resource.transaction: The ResourceTransaction interface allows operations to be performed on transactions
ResourceTransactionManager - Interface in org.jboss.forge.resource.transaction: The ResourceTransactionManager interface allows Starting a ResourceTransaction Getting the current ResourceTransaction
rollback() - Method in interface org.jboss.forge.resource.transaction.ResourceTransaction: Rolls back this transaction.

S

setContents(String) - Method in class org.jboss.forge.resource.AbstractFileResource: Set the contents of this AbstractFileResource to the given String
setContents(char[]) - Method in class org.jboss.forge.resource.AbstractFileResource: Set the contents of this AbstractFileResource to the given character array.
setContents(InputStream) - Method in class org.jboss.forge.resource.AbstractFileResource
setContents(String) - Method in interface org.jboss.forge.resource.FileResource: Set the contents of this FileResource to the given String
setContents(char[]) - Method in interface org.jboss.forge.resource.FileResource: Set the contents of this FileResource to the given character array.
setContents(InputStream) - Method in interface org.jboss.forge.resource.FileResource: Set the contents of this FileResource to the contents of the given InputStream.
startTransaction() - Method in interface org.jboss.forge.resource.transaction.ResourceTransactionManager: Start a new transaction.
supports(F) - Method in class org.jboss.forge.resource.AbstractResource

T

TempResourceCreated - Class in org.jboss.forge.resource.events: Fired when a temporary Resource has been created.
TempResourceCreated(Resource<?>) - Constructor for class org.jboss.forge.resource.events.TempResourceCreated
toString() - Method in class org.jboss.forge.resource.AbstractFileResource

U

URLResource - Interface in org.jboss.forge.resource: Represents a URL resource

V

VirtualResource<T> - Class in org.jboss.forge.resource: An abstract implementation of a virtual resource handle.
VirtualResource(ResourceFactory, Resource<?>) - Constructor for class org.jboss.forge.resource.VirtualResource

A C D E F G H I L M O P R S T U V