|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.rse.services.clientserver.archiveutils.VirtualChild
public final class VirtualChild
A simple structure for passing information about virtual files and folders.
Field Summary | |
---|---|
protected File |
_containingArchive
|
protected File |
_extractedFile
|
protected ISystemArchiveHandler |
_handler
|
String |
fullName
|
boolean |
isDirectory
|
String |
name
|
String |
path
|
Constructor Summary | |
---|---|
VirtualChild(ISystemArchiveHandler handler)
Constructs a new VirtualChild given a reference to its parent archive's handler, but does not populate any fields in the child. |
|
VirtualChild(ISystemArchiveHandler handler,
String fullVirtualName)
Constructs a new VirtualChild given a reference to its parent archive's handler ( handler ), and immediately populates the name and path info
for the VirtualChild given its fullVirtualName . |
|
VirtualChild(String fullVirtualName,
File containingArchive)
Constructs a new VirtualChild given the name of its parent archive, and immediately populates the name and path info for the VirtualChild given its fullVirtualName . |
Method Summary | |
---|---|
boolean |
exists()
|
String |
getArchiveStandardName()
|
String |
getComment()
|
long |
getCompressedSize()
|
String |
getCompressionMethod()
|
double |
getCompressionRatio()
|
File |
getContainingArchive()
|
File |
getExtractedFile()
|
void |
getExtractedFile(File destination,
ISystemOperationMonitor archiveOperationMonitor)
Gets the extracted file or directory represented by this VirtualChild from the archive, and replaces the object referred to by destination with that extracted file or directory. |
void |
getExtractedFile(File destination,
String sourceEncoding,
boolean isText,
ISystemOperationMonitor archiveOperationMonitor)
Gets the extracted file or directory represented by this VirtualChild from the archive, and replaces the object referred to by destination with that extracted file or directory. |
File |
getExtractedFile(String sourceEncoding,
boolean isText,
ISystemOperationMonitor archiveOperationMonitor)
|
ISystemArchiveHandler |
getHandler()
|
long |
getSize()
|
long |
getTimeStamp()
|
void |
renameTo(String newName)
Renames this virtual child to newName. |
void |
setComment(String value)
|
void |
setCompressedSize(long value)
|
void |
setCompressionMethod(String value)
|
void |
setSize(long value)
|
void |
setTimeStamp(long value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public String fullName
public String name
public String path
public boolean isDirectory
protected ISystemArchiveHandler _handler
protected File _extractedFile
protected File _containingArchive
Constructor Detail |
---|
public VirtualChild(ISystemArchiveHandler handler)
public VirtualChild(ISystemArchiveHandler handler, String fullVirtualName)
handler
), and immediately populates the name and path info
for the VirtualChild given its fullVirtualName
. Clients
must still populate the isDirectory field.
public VirtualChild(String fullVirtualName, File containingArchive)
fullVirtualName
. Clients
must still populate the isDirectory field.
NOTE: This constructor is intended only to be used for creating NON-EXISTENT
virtual children.
Method Detail |
---|
public ISystemArchiveHandler getHandler()
public long getTimeStamp()
public void setTimeStamp(long value)
value
- the time stamp valuepublic long getSize()
public void setSize(long value)
value
- the size valuepublic String getComment()
public void setComment(String value)
value
- the comment valuepublic long getCompressedSize()
public void setCompressedSize(long value)
value
- the compressedSize valuepublic String getCompressionMethod()
public void setCompressionMethod(String value)
value
- the compression method valuepublic double getCompressionRatio()
public File getExtractedFile() throws SystemMessageException
SystemMessageException
public File getExtractedFile(String sourceEncoding, boolean isText, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
SystemMessageException
public void getExtractedFile(File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
destination
with that extracted file or directory. Note that
the extracted file is cached after it is extracted once, but if the
timestamps on the cached and archived files do not match, the cached file
is erased, and re-extracted from the archive. destination
is
always overwritten with either what is cached, or what is in the archive.
SystemMessageException
- in case of an errorpublic void getExtractedFile(File destination, String sourceEncoding, boolean isText, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
destination
with that extracted file or directory. Note that
the extracted file is cached after it is extracted once, but if the
timestamps on the cached and archived files do not match, the cached file
is erased, and reextracted from the archive. destination
is
always overwritten with either what is cached, or what is in the archive.
SystemMessageException
- in case of an errorpublic boolean exists() throws SystemMessageException
SystemMessageException
public void renameTo(String newName)
public String getArchiveStandardName()
public File getContainingArchive()
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |