|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
boolean |
add(File[] files,
String virtualPath,
String[] names)
A generalization of the add method. |
boolean |
add(File[] files,
String virtualPath,
String[] names,
String[] encodings,
boolean[] isText)
A generalization of the add method. |
boolean |
add(File file,
String virtualPath,
String name)
Compresses the file file and adds it to the archive,
placing it in the virtual directory virtualPath . |
boolean |
add(File file,
String virtualPath,
String name,
String encoding,
boolean isText)
Compresses the file file and adds it to the archive,
saving it in the encoding specified by encoding if the isText is true.
|
boolean |
add(File file,
String virtualPath,
String name,
String encoding,
ISystemFileTypes typeRegistery)
Compresses the file file and adds it to the archive,
saving it in the encoding specified by encoding if the isText is true.
|
boolean |
create()
Turns the archive that this handler represents into a new, empty archive. |
boolean |
createFile(String fullVirtualName)
Creates a new, empty file in the archive. |
boolean |
createFolder(String fullVirtualName)
Creates a new, empty folder in the archive. |
boolean |
delete(String fullVirtualName)
Deletes the entry fullVirtualName from the archive, and returns
whether or not the deletion was successful. |
boolean |
exists()
|
boolean |
exists(String fullVirtualName)
|
boolean |
extractVirtualDirectory(String dir,
File destinationParent)
Extracts the directory dir (and its children) from
the archive and places the results in the directory destinationParent . |
boolean |
extractVirtualDirectory(String dir,
File destinationParent,
File destination)
Extracts the directory dir (and its children) from
the archive and places the results in the directory destinationParent .
|
boolean |
extractVirtualDirectory(String dir,
File destinationParent,
File destination,
String sourceEncoding,
boolean isText)
Extracts the directory dir (and its children) from
the archive and places the results in the directory destinationParent .
|
boolean |
extractVirtualDirectory(String dir,
File destinationParent,
String sourceEncoding,
boolean isText)
Extracts the directory dir (and its children) from
the archive and places the results in the directory destinationParent .
|
boolean |
extractVirtualFile(String fullVirtualName,
File destination)
Extracts the virtual file named fullVirtualName from the archive,
placing the results in destination . |
boolean |
extractVirtualFile(String fullVirtualName,
File destination,
String sourceEncoding,
boolean isText)
Extracts the virtual file named fullVirtualName from the archive,
placing the results in destination . |
boolean |
fullRename(String fullVirtualName,
String newFullVirtualName)
Replaces the full name and path of the entry fullVirtualName
with the new full name and path newFullVirtualName .
|
File |
getArchive()
|
String |
getArchiveComment()
|
String |
getClassification(String fullVirtualName)
Returns the classification for the entry with the given path. |
String |
getCommentFor(String fullVirtualName)
Gets the user-defined comment for a specific entry in the archive. |
long |
getCompressedSizeFor(String fullVirtualName)
Gets the amount of space taken up by a specific entry in the archive when it is in compressed form. |
String |
getCompressionMethodFor(String fullVirtualName)
Gets the method used to compress a specific entry in the archive. |
File[] |
getFiles(String[] fullNames)
Extracts and returns the specified list of virtual files from the archive. |
long |
getSizeFor(String fullVirtualName)
|
String |
getStandardName(VirtualChild vc)
Gets the archive-type specific standard name for the VirtualChild vc . |
long |
getTimeStampFor(String fullVirtualName)
|
VirtualChild[] |
getVirtualChildFolders(String fullVirtualName)
|
VirtualChild[] |
getVirtualChildren(String fullVirtualName)
|
VirtualChild[] |
getVirtualChildrenList()
|
VirtualChild[] |
getVirtualChildrenList(String parent)
|
VirtualChild |
getVirtualFile(String fullVirtualName)
|
boolean |
move(String fullVirtualName,
String destinationVirtualPath)
Moves the entry fullVirtualName to the location
specified by destinationVirtualPath , while leaving the entry with
the same name as before. |
boolean |
rename(String fullVirtualName,
String newName)
Renames the entry fullVirtualName to the new name
newName while still leaving the entry in the same virtual
directory. |
boolean |
replace(String fullVirtualName,
File file,
String name)
Compress the file file and replace the virtual file
referred to by fullVirtualName with the compressed file.
|
SystemSearchLineMatch[] |
search(String fullVirtualName,
SystemSearchStringMatcher matcher)
Searches for text within a virtual file in this archive. |
Method Detail |
public boolean create()
public VirtualChild[] getVirtualChildrenList()
public VirtualChild[] getVirtualChildrenList(String parent)
parent
.
Returns an array of length 0 if there are no such entries.public VirtualChild[] getVirtualChildren(String fullVirtualName)
fullVirtualName
. If fullVirtualName
is "",
returns the top level in the virtual file system tree. If there are no
values to return, returns null.public VirtualChild[] getVirtualChildFolders(String fullVirtualName)
fullVirtualName
that are themselves directories.
If fullVirtualName
is "",
returns the top level of directories in the virtual file system tree.
If there are no values to return, returns null.public VirtualChild getVirtualFile(String fullVirtualName)
fullVirtualName
.
This method never returns null. In cases where the VirtualChild does not
physically exist in the archive, this method returns a new VirtualChild object
whose exists() method returns false.public boolean exists(String fullVirtualName)
fullVirtualName
exists in the archive (physically).public boolean exists()
public File getArchive()
public long getTimeStampFor(String fullVirtualName)
fullVirtualName
public long getSizeFor(String fullVirtualName)
fullVirtualName
public boolean extractVirtualFile(String fullVirtualName, File destination)
fullVirtualName
from the archive,
placing the results in destination
.
fullVirtualName
- The full path and name of the virtual file in the archive.destination
- The destination file for the extracted virtual file.
public boolean extractVirtualFile(String fullVirtualName, File destination, String sourceEncoding, boolean isText)
fullVirtualName
from the archive,
placing the results in destination
. Extracts to the native encoding, but assumes
that the source was archived using sourceEncoding
if isText
is true.
fullVirtualName
- The full path and name of the virtual file in the archive.destination
- The destination file for the extracted virtual file.sourceEncoding
- The encoding of the file in the archive.isText
- Whether or not the virtual file is a text file.
public boolean extractVirtualDirectory(String dir, File destinationParent)
dir
(and its children) from
the archive and places the results in the directory destinationParent
.
dir
- The full name of the virtual directory to extractdestinationParent
- A handle to the directory in which the extracted
directory will be placed as a subdirectory.
public boolean extractVirtualDirectory(String dir, File destinationParent, String sourceEncoding, boolean isText)
dir
(and its children) from
the archive and places the results in the directory destinationParent
.
Extracts to the native encoding (if isText
), but assumes
that the source was archived using sourceEncoding
.
dir
- The full name of the virtual directory to extractdestinationParent
- A handle to the directory in which the extracted
directory will be placed as a subdirectory.sourceEncoding
- The encoding of the files in the archive.isText
- Whether or not the files in the directory are text files
public boolean extractVirtualDirectory(String dir, File destinationParent, File destination)
dir
(and its children) from
the archive and places the results in the directory destinationParent
.
The results will be named destination.getName() rather than dir
's name.
dir
- The full name of the virtual directory to extractdestinationParent
- A handle to the directory in which the extracted
directory will be placed as a subdirectory.destination
- A handle to the directory that will be created. Whatever
contents are in that directory will be replaced with what is extracted from
the archive.
public boolean extractVirtualDirectory(String dir, File destinationParent, File destination, String sourceEncoding, boolean isText)
dir
(and its children) from
the archive and places the results in the directory destinationParent
.
The results will be named destination.getName() rather than dir
's name.
Extracts to the native encoding (if isText
), but assumes
that the source was archived using sourceEncoding
.
dir
- The full name of the virtual directory to extractdestinationParent
- A handle to the directory in which the extracted
directory will be placed as a subdirectory.destination
- A handle to the directory that will be created. Whatever
contents are in that directory will be replaced with what is extracted from
the archive.sourceEncoding
- The encoding of the files in the archive.isText
- Whether or not the files to be extracted in the directory are all text files
public boolean add(File file, String virtualPath, String name)
file
and adds it to the archive,
placing it in the virtual directory virtualPath
. Pass the
name as the parameter name
. If the virtual path does not exist
in the archive, create it. If file
is a directory, copy it and
its contents into the archive, maintaining the tree structure.
public boolean add(File file, String virtualPath, String name, String encoding, boolean isText)
file
and adds it to the archive,
saving it in the encoding specified by encoding
if the isText is true.
placing it in the virtual directory virtualPath
. Pass the
name as the parameter name
. If the virtual path does not exist
in the archive, create it. If file
is a directory, copy it and
its contents into the archive, maintaining the tree structure.
public boolean add(File file, String virtualPath, String name, String encoding, ISystemFileTypes typeRegistery)
file
and adds it to the archive,
saving it in the encoding specified by encoding
if the isText is true.
placing it in the virtual directory virtualPath
. Pass the
name as the parameter name
. If the virtual path does not exist
in the archive, create it. If file
is a directory, copy it and
its contents into the archive, maintaining the tree structure.
public boolean add(File[] files, String virtualPath, String[] names)
files
and adds each of them to the archive, placing them
in the virtual directory virtualPath
. Pass the names of the files
as the parameter names
, where files[i]
has the name names[i]
.
If the virtual path does not exist in the archive, create it.
public boolean add(File[] files, String virtualPath, String[] names, String[] encodings, boolean[] isText)
files
and adds each of them to the archive, placing them
in the virtual directory virtualPath
. Save the i'th file in the i'th encoding (if isText[i] is true)
specified by encodings
. Pass the names of the files
as the parameter names
, where files[i]
has the name names[i]
.
If the virtual path does not exist in the archive, create it.
public boolean replace(String fullVirtualName, File file, String name)
file
and replace the virtual file
referred to by fullVirtualName
with the compressed file.
Pass the name of the file as the parameter name
.
public boolean delete(String fullVirtualName)
fullVirtualName
from the archive, and returns
whether or not the deletion was successful.
public boolean rename(String fullVirtualName, String newName)
fullVirtualName
to the new name
newName
while still leaving the entry in the same virtual
directory. Returns true if and only if the rename was successfull.
public boolean move(String fullVirtualName, String destinationVirtualPath)
fullVirtualName
to the location
specified by destinationVirtualPath
, while leaving the entry with
the same name as before. Returns true if and only if the move was successfull.
public boolean fullRename(String fullVirtualName, String newFullVirtualName)
fullVirtualName
with the new full name and path newFullVirtualName
.
Returns true if and only if the operation was successfull.
public File[] getFiles(String[] fullNames)
fullNames
- The list of files to return
public boolean createFolder(String fullVirtualName)
fullVirtualName
- The full name and path of the new folder within the virtual file system.
public boolean createFile(String fullVirtualName)
fullVirtualName
- The full name and path of the new file within the virtual file system.
public String getStandardName(VirtualChild vc)
vc
. For example, for Zips, if vc is a directory, then
the standard name must end with a "/".
public SystemSearchLineMatch[] search(String fullVirtualName, SystemSearchStringMatcher matcher)
fullVirtualName
- the virtual file to search.matcher
- the pattern matcher to use.
public String getCommentFor(String fullVirtualName)
fullVirtualName
- The entry who's comment is desired
public long getCompressedSizeFor(String fullVirtualName)
fullVirtualName
- The entry who's compressed size is desired
public String getCompressionMethodFor(String fullVirtualName)
fullVirtualName
- The entry who's compression method is desired
public String getArchiveComment()
public String getClassification(String fullVirtualName)
fullVirtualName
- the virtual name.
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |