org.jboss.forge.addon.resource

Interface FileResource<T extends FileResource<T>>

All Superinterfaces:

Faceted<ResourceFacet>, Resource<File>, WriteableResource<FileResource<T>,File>

All Known Subinterfaces:

DirectoryResource, GitIgnoreResource, JavaResource, JsonResource, MavenModelResource, XMLResource

All Known Implementing Classes:

AbstractFileResource

public interface FileResource<T extends FileResource<T>>
extends Resource<File>, WriteableResource<FileResource<T>,File>

A standard, built-in resource for representing files on the filesystem.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createNewFile() Create the file in the underlying resource system.
T	createTempResource() Create a temporary FileResource
void	deleteOnExit() Requests that the file or directory denoted by this resource be deleted when the virtual machine terminates.
long	getLastModified() Get the last modified time-stamp of this resource.
DirectoryResource	getParent() A parent for a FileResource is always a DirectoryResource
long	getSize() Returns the size of the file denoted by this abstract pathname
boolean	isDirectory() Return true if this FileResource exists and is actually a directory, otherwise return false;
boolean	isExecutable() Returns if a file is executable
boolean	isReadable() Returns if a file is readable
boolean	isStale() Returns true if the underlying resource has been modified on the file system since it was initially loaded.
boolean	isWritable() Returns if a file is writable
boolean	mkdir() Create a new single directory for this resource.
boolean	mkdirs() Create all directories required for this resource to exist.
ResourceMonitor	monitor() Monitors this FileResource
ResourceMonitor	monitor(ResourceFilter filter) Monitors this FileResource using the given filter
void	refresh() Re-read the file-system meta-data for this resource (such as last modified time-stamp, and permissions.)
boolean	renameTo(FileResource<?> target) Rename this Resource to the given FileResource
boolean	renameTo(String pathspec) Rename this Resource to the given path.
void	setLastModified(long currentTimeMillis) Set the last modified time-stamp of this resource.

Methods inherited from interface org.jboss.forge.addon.resource.WriteableResource

getResourceOutputStream, setContents, setContents, setContents, setContents, setContents

Methods inherited from interface org.jboss.forge.addon.resource.Resource

createFrom, delete, delete, exists, getChild, getContents, getContents, getFullyQualifiedName, getName, getResourceFactory, getResourceInputStream, getUnderlyingResourceObject, listResources, listResources, reify, resolveChildren

Methods inherited from interface org.jboss.forge.addon.facets.Faceted

getFacet, getFacets, getFacets, hasAllFacets, hasAllFacets, hasFacet, supports

Method Detail

isDirectory

boolean isDirectory()

Return true if this FileResource exists and is actually a directory, otherwise return false;

isStale

boolean isStale()

Returns true if the underlying resource has been modified on the file system since it was initially loaded.

Returns:

boolean true if resource is changed.

refresh

void refresh()

Re-read the file-system meta-data for this resource (such as last modified time-stamp, and permissions.)

mkdir

boolean mkdir()

Create a new single directory for this resource. This will not succeed if any parent directories needed for this resource to exist are missing. You should consider using mkdirs()

mkdirs

boolean mkdirs()

Create all directories required for this resource to exist.

deleteOnExit

void deleteOnExit()

Requests that the file or directory denoted by this resource be deleted when the virtual machine terminates.

Once deletion has been requested, it is not possible to cancel the request. This method should therefore be used with care.

createNewFile

boolean createNewFile()

Create the file in the underlying resource system. Necessary directory paths will be created automatically.

createTempResource

T createTempResource()

Create a temporary FileResource

renameTo

boolean renameTo(String pathspec)

Rename this Resource to the given path.

renameTo

boolean renameTo(FileResource<?> target)

Rename this Resource to the given FileResource

getSize

long getSize()

Returns the size of the file denoted by this abstract pathname

isWritable

boolean isWritable()

Returns if a file is writable

isReadable

boolean isReadable()

Returns if a file is readable

isExecutable

boolean isExecutable()

Returns if a file is executable

getParent

DirectoryResource getParent()

A parent for a FileResource is always a DirectoryResource

Specified by:

getParent in interface Resource<File>

Returns:

An instance of the Resource parent.

monitor

ResourceMonitor monitor()

Monitors this FileResource

monitor

ResourceMonitor monitor(ResourceFilter filter)

Monitors this FileResource using the given filter

getLastModified

long getLastModified()

Get the last modified time-stamp of this resource.

setLastModified

void setLastModified(long currentTimeMillis)

Set the last modified time-stamp of this resource.