Eclipse RSE Development Guide (Galileo) - IRemoteFileContext (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.subsystems.files.core.subsystems
Interface IRemoteFileContext

All Known Implementing Classes:: RemoteFileContext

public interface IRemoteFileContext

This interface represents a place to hold contextual information stored within each remote file object.

We store in here information that might be the same for multiple remote file objects, in order to save memory. This way, we can merely hold a reference to a single object, which itself may have numerous pieces of information helpful when processing actions on a particular remote object.

Method Summary

void addFilterString ( RemoteFileFilterString additionalFilterString)
          Add an additional filter string.

RemoteFileFilterString[] getAllFilterStrings ()
          Return all the filter string objects applicable to this folder object.

RemoteFileFilterString getFilterString ()
          Return the filter string used to resolve the list resulting in this remote object.

IRemoteFile getParentRemoteFile ()
          Return the parent remote file object expanded to get this object, or null if no such parent

IRemoteFileSubSystem getParentRemoteFileSubSystem ()
          Get parent subsystem

void setFilterString ( RemoteFileFilterString filterString)
          Set the filter string used to resolve the list resulting in this remote object.

void setParentRemoteFile ( IRemoteFile parentFile)
          Set the parent remote file object expanded to get this object, or null if no such parent

void setParentRemoteFileSubSystem ( IRemoteFileSubSystem parentSubSystem)
          Set parent subsystem

Method Detail

getParentRemoteFileSubSystem


IRemoteFileSubSystem getParentRemoteFileSubSystem()

Get parent subsystem

getParentRemoteFile


IRemoteFile getParentRemoteFile()

Return the parent remote file object expanded to get this object, or null if no such parent

getFilterString


RemoteFileFilterString getFilterString()

Return the filter string used to resolve the list resulting in this remote object.

getAllFilterStrings


RemoteFileFilterString[] getAllFilterStrings()

Return all the filter string objects applicable to this folder object.

setParentRemoteFileSubSystem

void setParentRemoteFileSubSystem(
IRemoteFileSubSystem parentSubSystem)

Set parent subsystem

setParentRemoteFile

void setParentRemoteFile(
IRemoteFile parentFile)

Set the parent remote file object expanded to get this object, or null if no such parent

setFilterString

void setFilterString(
RemoteFileFilterString filterString)

Set the filter string used to resolve the list resulting in this remote object.

addFilterString

void addFilterString(
RemoteFileFilterString additionalFilterString)

Add an additional filter string. This is called for folders in a multi-filter string filter. It is called for each filter string that lists the contents of the same parent path, when show subdirs is true. It is needed to support the subsequent expansion of this subdirectory, so that it can filter on all the appropriate filter strings.