|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectrailo.commons.io.res.util.ResourceSupport
public abstract class ResourceSupport
Helper class to build resources
Field Summary |
---|
Fields inherited from interface railo.commons.io.res.Resource |
---|
ATTRIBUTE_ARCHIVE, ATTRIBUTE_HIDDEN, ATTRIBUTE_SYSTEM |
Constructor Summary | |
---|---|
ResourceSupport()
|
Method Summary | |
---|---|
boolean |
canRead()
Tests whether the application can read the resource denoted by this abstract pathname. |
boolean |
canWrite()
Tests whether the application can modify the resource denoted by this abstract pathname. |
void |
copyFrom(Resource res,
boolean append)
copy data of given resource to current |
void |
copyTo(Resource res,
boolean append)
copy current resource data to given resource |
boolean |
createNewFile()
Creates a new, empty file named by this abstract pathname if and only if a file with this name does not yet exist. |
boolean |
delete()
Deletes the resource denoted by this abstract pathname. |
boolean |
equals(Object obj)
|
String |
getAbsolutePath()
Returns the absolute pathname string of this abstract pathname. |
Resource |
getAbsoluteResource()
Returns the absolute form of this abstract pathname. |
boolean |
getAttribute(short attribute)
return value of a specific attribute |
String |
getCanonicalPath()
Returns the canonical pathname string of this abstract pathname. |
Resource |
getCanonicalResource()
Returns the canonical form of this abstract pathname. |
OutputStream |
getOutputStream()
|
String |
getReal(String realpath)
returns a resource path that is relative to the current resource |
boolean |
isArchive()
Tests whether the resource named by this abstract pathname is a archive resource. |
boolean |
isHidden()
Tests whether the resource named by this abstract pathname is a hidden resource. |
boolean |
isSystem()
Tests whether the resource named by this abstract pathname is a system resource. |
String[] |
list()
Returns an array of strings naming the files and directories in the directory denoted by this abstract pathname. |
String[] |
list(ResourceFilter filter)
|
String[] |
list(ResourceNameFilter filter)
Returns an array of strings naming the files and directories in the directory denoted by this abstract pathname that satisfy the specified filter. |
Resource[] |
listResources(ResourceFilter filter)
Returns an array of abstract pathnames denoting the files and directories in the directory denoted by this abstract pathname that satisfy the specified filter. |
Resource[] |
listResources(ResourceNameFilter filter)
Returns an array of abstract pathnames denoting the files and directories in the directory denoted by this abstract pathname that satisfy the specified filter. |
boolean |
mkdir()
Creates the directory named by this abstract pathname. |
boolean |
mkdirs()
Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories. |
void |
moveTo(Resource dest)
Move/renames the file denoted by this abstract pathname. |
boolean |
renameTo(Resource dest)
Move/renames the file denoted by this abstract pathname. |
void |
setArchive(boolean value)
sets archive attribute of the resource |
void |
setAttribute(short attribute,
boolean value)
sets a attribute on the resource if supported otherwise it will ign |
void |
setHidden(boolean value)
sets hidden attribute of the resource |
boolean |
setReadOnly()
Marks the file or directory named by this abstract pathname so that only read operations are allowed. |
void |
setSystem(boolean value)
sets system attribute of the resource |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface railo.commons.io.res.Resource |
---|
createDirectory, createFile, exists, getInputStream, getMode, getName, getOutputStream, getParent, getParentResource, getPath, getRealResource, getResourceProvider, isAbsolute, isDirectory, isFile, isReadable, isWriteable, lastModified, length, listResources, remove, setLastModified, setMode, setReadable, setWritable |
Constructor Detail |
---|
public ResourceSupport()
Method Detail |
---|
public void copyFrom(Resource res, boolean append) throws IOException
Resource
copyFrom
in interface Resource
IOException
Resource.copyFrom(railo.commons.io.res.Resource,boolean)
public void copyTo(Resource res, boolean append) throws IOException
Resource
copyTo
in interface Resource
IOException
Resource.copyTo(railo.commons.io.res.Resource,boolean)
public Resource getAbsoluteResource()
Resource
getAbsoluteResource
in interface Resource
res.Resource#getAbsoluteResource()
public String getAbsolutePath()
Resource
If this abstract pathname is already absolute, then the pathname
string is simply returned as if by the
method.
Resource.getPath()
getAbsolutePath
in interface Resource
res.Resource#getAbsolutePath()
public OutputStream getOutputStream() throws IOException
getOutputStream
in interface Resource
IOException
res.Resource#getOutputStream()
public Resource getCanonicalResource() throws IOException
Resource
getCanonicalResource
in interface Resource
IOException
- If an I/O error occurs, which is possible because the
construction of the canonical pathname may require
filesystem queriesres.Resource#getCanonicalResource()
public String getCanonicalPath() throws IOException
Resource
A canonical pathname is both absolute and unique. The precise
definition of canonical form is system-dependent. This method first
converts this pathname to absolute form if necessary, as if by invoking the
Resource.getAbsolutePath()
method, and then maps it to its unique form in a
system-dependent way. This typically involves removing redundant names
such as "." and ".." from the pathname.
Every pathname that denotes an existing file or directory has a unique canonical form. Every pathname that denotes a nonexistent resource also has a unique canonical form. The canonical form of the pathname of a nonexistent file or directory may be different from the canonical form of the same pathname after the resource is created. Similarly, the canonical form of the pathname of an existing resource may be different from the canonical form of the same pathname after the resource is deleted.
getCanonicalPath
in interface Resource
IOException
- If an I/O error occurs, which is possible because the
construction of the canonical pathname may require
filesystem queriesres.Resource#getCanonicalPath()
public void moveTo(Resource dest) throws IOException
Resource
Many aspects of the behavior of this method are inherently platform-dependent: The rename operation might not be able to move a file from one filesystem to another, it might not be atomic, and it might not succeed if a file with the destination abstract pathname already exists.
moveTo
in interface Resource
dest
- The new abstract pathname for the named file
IOException
- throwed when operation not done sucessfullres.Resource#moveTo(res.Resource)
public String[] list(ResourceFilter filter)
list
in interface Resource
res.Resource#list(res.filter.ResourceFilter)
public String[] list(ResourceNameFilter filter)
Resource
Resource.list()
method, except that the strings in the
returned array must satisfy the filter. If the given
filter
is null
then all names are accepted.
Otherwise, a name satisfies the filter if and only if the value
true
results when the ResourceNameFilter.accept(railo.commons.io.res.Resource, java.lang.String)
method of the filter is invoked on this
abstract pathname and the name of a file or directory in the directory
that it denotes.
list
in interface Resource
filter
- A resourcename filter
filter
. The array will be empty if
the directory is empty or if no names were accepted by the
filter. Returns null
if this abstract pathname
does not denote a directory, or if an I/O error occurs.res.Resource#list(res.filter.ResourceNameFilter)
public Resource[] listResources(ResourceNameFilter filter)
Resource
Resource.listResources()
method, except
that the pathnames in the returned array must satisfy the filter.
If the given filter
is null
then all
pathnames are accepted. Otherwise, a pathname satisfies the filter
if and only if the value true
results when the
ResourceNameFilter.accept(railo.commons.io.res.Resource, java.lang.String)
method of the filter is
invoked on this abstract pathname and the name of a file or
directory in the directory that it denotes.
listResources
in interface Resource
filter
- A resourcename filter
null
if this abstract pathname
does not denote a directory, or if an I/O error occurs.res.Resource#listResources(res.filter.ResourceNameFilter)
public Resource[] listResources(ResourceFilter filter)
Resource
Resource.listResources()
method, except
that the pathnames in the returned array must satisfy the filter.
If the given filter
is null
then all
pathnames are accepted. Otherwise, a pathname satisfies the filter
if and only if the value true
results when the
ResourceFilter.accept(Resource)
method of
the filter is invoked on the pathname.
listResources
in interface Resource
filter
- A resource filter
null
if this abstract pathname
does not denote a directory, or if an I/O error occurs.res.Resource#listResources(res.filter.ResourceFilter)
public String getReal(String realpath)
Resource
getReal
in interface Resource
res.Resource#getReal(java.lang.String)
public String[] list()
Resource
If this abstract pathname does not denote a directory, then this
method returns null
. Otherwise an array of strings is
returned, one for each file or directory in the directory. Names
denoting the directory itself and the directory's parent directory are
not included in the result. Each string is a file name rather than a
complete path.
There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
list
in interface Resource
null
if
this abstract pathname does not denote a directory, or if an
I/O error occurs.res.Resource#list()
public boolean canRead()
Resource
canRead
in interface Resource
true
if and only if the resource specified by this
abstract pathname exists and can be read by the
application; false
otherwiseres.Resource#canRead()
public boolean canWrite()
Resource
canWrite
in interface Resource
true
if and only if the resource system actually
contains a resource denoted by this abstract pathname and
the application is allowed to write to the resource;
false
otherwise.res.Resource#canWrite()
public boolean renameTo(Resource dest)
Resource
Many aspects of the behavior of this method are inherently platform-dependent: The rename operation might not be able to move a file from one filesystem to another, it might not be atomic, and it might not succeed if a file with the destination abstract pathname already exists.
renameTo
in interface Resource
dest
- The new abstract pathname for the named file
res.Resource#renameTo(res.Resource)
public boolean createNewFile()
Resource
createNewFile
in interface Resource
true
if the named file does not exist and was
successfully created; false
if the named file
already existsres.Resource#createNewFile()
public boolean mkdir()
Resource
mkdir
in interface Resource
true
if and only if the directory was
created; false
otherwiseres.Resource#mkdir()
public boolean mkdirs()
Resource
mkdirs
in interface Resource
true
if and only if the directory was created,
along with all necessary parent directories; false
otherwiseres.Resource#mkdirs()
public boolean delete()
Resource
delete
in interface Resource
Resource.delete()
public boolean isArchive()
Resource
isArchive
in interface Resource
true
if and only if the file denoted by this
abstract pathname is a archiveResource.isArchive()
public boolean isSystem()
Resource
isSystem
in interface Resource
true
if and only if the file denoted by this
abstract pathname is a system resourceResource.isSystem()
public boolean isHidden()
Resource
isHidden
in interface Resource
true
if and only if the file denoted by this
abstract pathname is hiddenResource.isHidden()
public void setArchive(boolean value) throws IOException
Resource
setArchive
in interface Resource
IOException
- throwed when no access to change the value or the resource doesn't existsResource.setArchive(boolean)
public void setHidden(boolean value) throws IOException
Resource
setHidden
in interface Resource
IOException
- throwed when no access to change the value or the resource doesn't existsResource.setHidden(boolean)
public boolean setReadOnly()
Resource
setReadOnly
in interface Resource
true
if and only if the operation succeeded;
false
otherwiseResource.setReadOnly()
public void setSystem(boolean value) throws IOException
Resource
setSystem
in interface Resource
IOException
- throwed when no access to change the value or the resource doesn't existsResource.setSystem(boolean)
public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public String toString()
toString
in class Object
Object.toString()
public boolean getAttribute(short attribute)
Resource
getAttribute
in interface Resource
Resource.getAttribute(short)
public void setAttribute(short attribute, boolean value) throws IOException
Resource
setAttribute
in interface Resource
attribute
- wich attrbute (Resource.ATTRIBUTE_*)
IOException
- throwed when no access to change the value,
when attributes are not supported or
the resource doesn't existsResource.setAttribute(short, boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |