|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteFile
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:
ISystemEditableRemoteObject
.
IRemoteFileSubSystem
interface. All remote commands/actions are routed
through subsystems in this remote system framework.
IRemoteFileSubSystem.getRemoteFileObject(String, org.eclipse.core.runtime.IProgressMonitor)
,
and related methods, which may delegate the actual object creation to an
IHostFileToRemoteFileAdapter
in case of an IFileServiceSubSystem
instance.
Note for subsystem providers: this method does not capture the set methods that the
RemoteFile class defines. For that, cast to RemoteFile
.
Field Summary | |
---|---|
static char |
CONNECTION_DELIMITER
|
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()
|
String |
getEncoding()
Returns the encoding of the remote file. |
String |
getExtension()
Return the extension part of a file name. |
Object |
getFile()
Get the object. |
RemoteFileFilterString |
getFilterString()
Return the filter string resolved to get this object |
IHost |
getHost()
Return the connection this remote file is from. |
IHostFile |
getHostFile()
|
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 |
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. |
String |
getParentPath()
Get fully qualified path and name of folder containing this file or folder. |
IRemoteFile |
getParentRemoteFile()
Return the parent remote file object expanded to get this object, or null if no such parent exists. |
IRemoteFileSubSystem |
getParentRemoteFileSubSystem()
Get parent subsystem. |
IHostFilePermissions |
getPermissions()
Returns the permissions for this file if they exist |
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 /. |
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 |
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 org.eclipse.rse.core.subsystems.IRemoteContainer |
---|
copyContentsTo, getContents, hasContents, replaceContent, setContents |
Methods inherited from interface org.eclipse.rse.core.model.ISystemContainer |
---|
getContents, hasContents, isStale, markStale, markStale |
Methods inherited from interface org.eclipse.rse.core.subsystems.IRemotePropertyHolder |
---|
getProperties, getProperty, isPropertyStale, markAllPropertiesStale, markPropertyStale, setProperties, setProperty |
Methods inherited from interface org.eclipse.core.runtime.jobs.ISchedulingRule |
---|
contains, isConflicting |
Field Detail |
---|
static final char CONNECTION_DELIMITER
static final boolean ISROOT_YES
static final boolean ISROOT_NO
Method Detail |
---|
boolean showBriefPropertySet()
IRemoteFileSubSystem getParentRemoteFileSubSystem()
char getSeparatorChar()
String getSeparator()
String getLineSeparator()
IHost getHost()
IRemoteFile getParentRemoteFile()
null
if no such parent exists.
null
.RemoteFileFilterString getFilterString()
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.
String getAbsolutePath()
null
.String getAbsolutePathPlusConnection()
String getLabel()
String getName()
String getParentPath()
If this object represent only a root drive, this returns null;
Example: c:\folder1\folder2\file1.ext
results in c:\folder1\folder2
String getParentNoRoot()
If this object represent only a root drive, this returns null;
Example: c:\folder1\folder2\file1.ext
results in folder1\folder2
String getRoot()
c:\folder1\folder2\file1.ext
results in c:\
/folder1/folder2/file1.ext
results in /
String getParentName()
Example: c:\folder1\folder2\file1.ext
results in folder2
String getExtension()
boolean isRoot()
boolean isDirectory()
boolean isFile()
boolean isArchive()
boolean isBinary()
boolean isText()
boolean isHidden()
boolean canRead()
boolean canWrite()
boolean exists()
long getLastModified()
Date getLastModifiedDate()
long getLength()
boolean showReadOnlyProperty()
int compareTo(Object other) throws ClassCastException
ClassCastException
Object getFile()
boolean isAncestorOf(IRemoteFile file)
boolean isDescendantOf(IRemoteFile file)
String getComment()
String getClassification()
null
if not classifiable.boolean isExecutable()
true
if the file is executable, false
otherwise.boolean isLink()
true
if the file is a symbolic link, false
otherwise.String getCanonicalPath()
IHostFile getHostFile()
String getEncoding()
IHostFilePermissions getPermissions()
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |