org.eclipse.rse.core.subsystems
Interface IRemotePropertyHolder

All Known Subinterfaces:

IRemoteFile, IVirtualRemoteFile

All Known Implementing Classes:

AbstractRemoteFile, RemoteFile, RemoteFileEmpty, RemoteFileRoot

public interface IRemotePropertyHolder

This interface should be implemented by any remote artifact that contains remote properties and (optionally) caches them.

Method Summary

java.lang.Object[]	getProperties(java.lang.String[] keys) Returns the value of the properties with the given keys.
java.lang.Object	getProperty(java.lang.String key) Returns the value of the property with the given key.
boolean	isPropertyStale(java.lang.String key) Returns whether the property with the given key is stale.
void	markAllPropertiesStale() Marks all properties as stale.
void	markPropertyStale(java.lang.String key) Marks the property with the given key as stale.
void	setProperties(java.lang.String[] keys, java.lang.Object[] values) Sets the values of the properties with the given keys.
void	setProperty(java.lang.String key, java.lang.Object value) Sets the value of the property with the given key.

Method Detail

getProperty

java.lang.Object getProperty(java.lang.String key)

Returns the value of the property with the given key.

Parameters:

key - the property key.

Returns:

the value of the property.

getProperties

java.lang.Object[] getProperties(java.lang.String[] keys)

Returns the value of the properties with the given keys.

Parameters:

keys - the property keys.

Returns:

the correspoding values of the properties.

setProperty

void setProperty(java.lang.String key,
                 java.lang.Object value)

Sets the value of the property with the given key.

Parameters:

key - the property key.

value - the value of the property.

setProperties

void setProperties(java.lang.String[] keys,
                   java.lang.Object[] values)

Sets the values of the properties with the given keys.

Parameters:

keys - the property keys.

values - the corresponding values of the properties.

isPropertyStale

boolean isPropertyStale(java.lang.String key)

Returns whether the property with the given key is stale.

Parameters:

key - the property key.

Returns:

true if the property is stale, false otherwise.

markPropertyStale

void markPropertyStale(java.lang.String key)

Marks the property with the given key as stale.

Parameters:

key - the property key.

markAllPropertiesStale

void markAllPropertiesStale()

Marks all properties as stale.