|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents a handle to a remote file system object, which is either a file or a folder. This interface is similar to a java.io.File object, but with some significant differences:
Note for subsystem providers: this method does not capture the set methods that the RemoteFileImpl class defines. For that, cast to IRemoteFileMutable.
Field Summary | |
---|---|
static char |
CONNECTION_DELIMITER
|
static String |
copyright
|
static boolean |
ISROOT_NO
|
static boolean |
ISROOT_YES
|
Method Summary | |
---|---|
boolean |
canRead()
Returns true if the application can read this file. |
boolean |
canWrite()
Returns true if the application can write to this file. |
int |
compareTo(Object other)
Compare one remote file to another. |
boolean |
exists()
Returns true if this folder or file actually exists. |
String |
getAbsolutePath()
Get fully qualified name: root plus path plus name. |
String |
getAbsolutePathPlusConnection()
Get fully qualified connection and file name: profile.connection\path\file. |
RemoteFileFilterString[] |
getAllFilterStrings()
If this is a folder, it is possible that it is listed as part of a multiple filter string filter. |
String |
getCanonicalPath()
Returns the canonical path of the remote file. |
String |
getClassification()
Returns the classification of this file. |
String |
getComment()
|
long |
getCompressedSize()
|
String |
getCompressionMethod()
|
double |
getCompressionRatio()
|
long |
getExpandedSize()
|
String |
getExtension()
Return the extension part of a file name. |
Object |
getFile()
Get the object. |
File |
getFileWrapper()
Return an object extending java.io.File and proxing this file. |
RemoteFileFilterString |
getFilterString()
Return the filter string resolved to get this object |
String |
getLabel()
Get the display name for this file. |
long |
getLastModified()
Returns the time (in milliseconds since epoch) this file was last modified. |
Date |
getLastModifiedDate()
Return the last modified time as a Date object. |
long |
getLength()
Returns the length, in bytes, of this file. |
String |
getLineSeparator()
Return as a string the line separator for this file system Queries it from the subsystem factory. |
String |
getName()
Get unqualified file name. |
String |
getParent()
Get fully qualified path and name of folder containing this file or folder. |
String |
getParentName()
Get the unqualified name of the parent directory containing this file or folder. |
String |
getParentNoRoot()
Get fully qualified path and name of folder containing this file or folder, minus the root. |
IRemoteFile |
getParentRemoteFile()
Return the parent remote file object expanded to get this object, or null if no such parent |
RemoteFileSubSystem |
getParentRemoteFileSubSystem()
Get parent subsystem |
String |
getRoot()
Get the root part of the name. |
String |
getSeparator()
Return the separator character for this file system, as a string: "\" or "/". |
char |
getSeparatorChar()
Return the separator character for this file system: \ or /. |
SystemConnection |
getSystemConnection()
Return the connection this remote file is from. |
boolean |
isAncestorOf(IRemoteFile file)
Note: if this remoteFile is the same as the file passed as parameter, then this method returns true. |
boolean |
isArchive()
Returns true if this represents an archive file, versues a non-archive file |
boolean |
isBinary()
Returns true if this is a binary file |
boolean |
isDescendantOf(IRemoteFile file)
Note: if this remoteFile is the same as the file passed as parameter, then this method returns true. |
boolean |
isDirectory()
Returns true if this represents a folder (eg: c:\\folder) |
boolean |
isExecutable()
Returns whether the file is executable or not. |
boolean |
isFile()
Returns true if this represents a file, versus a root or folder |
boolean |
isHidden()
Returns true if this is a hidden file. |
boolean |
isLink()
Returns whether the file is a symbolic link or not. |
boolean |
isRoot()
Returns true if this represents a root folder (eg: c:\\ or /). |
boolean |
isText()
Returns true if this is a text file |
boolean |
isVirtual()
Returns true if this is a virtual file. |
void |
setFilterString(RemoteFileFilterString filterString)
Set the filter string resolved to get this object |
boolean |
showBriefPropertySet()
Querying properties for the property sheet can be expensive on some operating systems. |
boolean |
showReadOnlyProperty()
Returns true if the ReadOnly Property should be shown in the property page. |
Methods inherited from interface com.ibm.etools.systems.subsystems.IRemoteContainer |
---|
copyContentsTo, getContents, hasContents, replaceContent, setContents |
Methods inherited from interface com.ibm.etools.systems.model.ISystemContainer |
---|
getContents, hasContents, isStale, markStale |
Methods inherited from interface com.ibm.etools.systems.subsystems.IRemotePropertyHolder |
---|
getProperties, getProperty, isPropertyStale, markAllPropertiesStale, markPropertyStale, setProperties, setProperty |
Field Detail |
public static final String copyright
public static final char CONNECTION_DELIMITER
public static final boolean ISROOT_YES
public static final boolean ISROOT_NO
Method Detail |
public boolean showBriefPropertySet()
public RemoteFileSubSystem getParentRemoteFileSubSystem()
public char getSeparatorChar()
public String getSeparator()
public String getLineSeparator()
public SystemConnection getSystemConnection()
public IRemoteFile getParentRemoteFile()
public RemoteFileFilterString getFilterString()
public RemoteFileFilterString[] getAllFilterStrings()
This method supports that by returning all the filter strings in the filter which have the same parent path as was used to produce this file.
public void setFilterString(RemoteFileFilterString filterString)
public String getAbsolutePath()
public String getAbsolutePathPlusConnection()
public String getLabel()
public String getName()
public String getParent()
If this object represent only a root drive, this returns null;
Example: c:\folder1\folder2\file1.ext
results in c:\folder1\folder2
public String getParentNoRoot()
If this object represent only a root drive, this returns null;
Example: c:\folder1\folder2\file1.ext
results in folder1\folder2
public String getRoot()
c:\folder1\folder2\file1.ext
results in c:\
/folder1/folder2/file1.ext
results in /
public String getParentName()
Example: c:\folder1\folder2\file1.ext
results in folder2
public String getExtension()
public boolean isRoot()
public boolean isDirectory()
public boolean isFile()
public boolean isArchive()
public boolean isBinary()
public boolean isText()
public boolean isHidden()
public boolean isVirtual()
public boolean canRead()
public boolean canWrite()
public boolean exists()
public long getLastModified()
public Date getLastModifiedDate()
public long getLength()
public boolean showReadOnlyProperty()
public File getFileWrapper()
public int compareTo(Object other) throws ClassCastException
ClassCastException
public Object getFile()
public boolean isAncestorOf(IRemoteFile file)
public boolean isDescendantOf(IRemoteFile file)
public double getCompressionRatio()
public String getComment()
public String getClassification()
public boolean isExecutable()
true
if the file is executable, false
otherwise.public boolean isLink()
true
if the file is a symbolic link, false
otherwise.public String getCanonicalPath()
public String getCompressionMethod()
public long getCompressedSize()
public long getExpandedSize()
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |