Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.files.ui.resources
Interface ISystemRemoteMarker


public interface ISystemRemoteMarker

This interface defines a remote marker. It can be used to tag information to a any remote resource. Clients must not implement this interface.


Field Summary
static  String EXTENSION_POINT_ID
          Remote markers extension point id.
 
Method Summary
 void delete ()
          Deletes this marker from its associated resource.
 boolean equals ( Object object)
          Tests this marker for equality with the given object.
 boolean exists ()
          Returns whether this marker exists.
  Object getAttribute ( String attributeName)
          Returns the attribute with the given name.
 boolean getAttribute ( String attributeName, boolean defaultValue)
          Returns the boolean-valued attribute with the given name.
 int getAttribute ( String attributeName, int defaultValue)
          Returns the integer-valued attribute with the given name.
  String getAttribute ( String attributeName, String defaultValue)
          Returns the string-valued attribute with the given name.
  Map getAttributes ()
          Returns a map with all the attributes for the marker.
  Object[] getAttributes ( String[] attributeNames)
          Returns the attributes with the given names.
 long getCreationTime ()
          Returns the time at which this marker was created.
 long getId ()
          Returns the id of the marker.
  ISystemRemoteResource getResource ()
          Returns the resource with which this marker is associated.
  String getType ()
          Returns the type of this marker.
 boolean isSubtypeOf ( String superType)
          Returns whether the type of this marker is considered to be a subtype of the given marker type.
 void setAttribute ( String attributeName, boolean value)
          Sets the boolean-valued attribute with the given name.
 void setAttribute ( String attributeName, int value)
          Sets the integer-valued attribute with the given name.
 void setAttribute ( String attributeName, Object value)
          Sets the attribute with the given name.
 void setAttributes ( Map attributes)
          Sets the attributes for this marker to be the ones contained in the given table.
 void setAttributes ( String[] attributeNames, Object[] values)
          Sets the given attribute key-value pairs on this marker.
 

Field Detail

EXTENSION_POINT_ID

static final 
String EXTENSION_POINT_ID
Remote markers extension point id.

See Also:
Constant Field Values
Method Detail

delete

void delete()
Deletes this marker from its associated resource. This method has no effect if this marker does not exist.


equals

boolean equals(
Object object)
Tests this marker for equality with the given object. Two markers are equal if and only if their id and resource info are both equal.

Overrides:
equals in class Object
Parameters:
object - the other object
Returns:
true if objects are equal, false otherwise

exists

boolean exists()
Returns whether this marker exists. A marker exists if its resource info exists and has a marker with the marker's id.

Returns:
true if this marker exists, otherwise false

getAttribute

Object getAttribute(
String attributeName)
Returns the attribute with the given name. The result is an instance of one of the following classes: String, Integer, or Boolean. Returns null if the attribute is undefined.

Parameters:
attributeName - the name of the attribute
Returns:
the value, or null if the attribute is undefined.

getAttribute

int getAttribute(
String attributeName,
                 int defaultValue)
Returns the integer-valued attribute with the given name. Returns the given default value if the attribute is undefined. or the marker does not exist or is not an integer value.

Parameters:
attributeName - the name of the attribute
defaultValue - the value to use if no value is found
Returns:
the value or the default value if no value was found.

getAttribute

String getAttribute(
String attributeName,
                    
String defaultValue)
Returns the string-valued attribute with the given name. Returns the given default value if the attribute is undefined or the marker does not exist or is not a string value.

Parameters:
attributeName - the name of the attribute
defaultValue - the value to use if no value is found
Returns:
the value or the default value if no value was found.

getAttribute

boolean getAttribute(
String attributeName,
                     boolean defaultValue)
Returns the boolean-valued attribute with the given name. Returns the given default value if the attribute is undefined or the marker does not exist or is not a boolean value.

Parameters:
attributeName - the name of the attribute
defaultValue - the value to use if no value is found
Returns:
the value or the default value if no value was found.

getAttributes

Map getAttributes()
Returns a map with all the attributes for the marker. If the marker has no attributes then null is returned.

Returns:
a map of attribute keys and values (key type : String value type : String, Integer, or Boolean) or null.

getAttributes

Object[] getAttributes(
String[] attributeNames)
Returns the attributes with the given names. The result is an an array whose elements correspond to the elements of the given attribute name array. Each element is null or an instance of one of the following classes: String, Integer, or Boolean.

Parameters:
attributeNames - the names of the attributes
Returns:
the values of the given attributes.

getCreationTime

long getCreationTime()
Returns the time at which this marker was created.

Returns:
the difference, measured in milliseconds, between the time at which this marker was created and midnight, January 1, 1970 UTC.

getId

long getId()
Returns the id of the marker. The id of a marker is unique relative to the resource with which the marker is associated. Marker ids are not globally unique.

Returns:
the id of the marker
See Also:
ISystemRemoteResource.findMarker(long)

getResource

ISystemRemoteResource getResource()
Returns the resource with which this marker is associated.

Returns:
the remote resource with which this marker is associated

getType

String getType()
Returns the type of this marker.

Returns:
the type of this marker

isSubtypeOf

boolean isSubtypeOf(
String superType)
Returns whether the type of this marker is considered to be a subtype of the given marker type.

Returns:
boolean trueif the marker's type is the same as (or a subtype of) the given type.

setAttribute

void setAttribute(
String attributeName,
                  int value)
Sets the integer-valued attribute with the given name.

Parameters:
attributeName - the name of the attribute
value - the value

setAttribute

void setAttribute(
String attributeName,
                  
Object value)
Sets the attribute with the given name. The value must be null or an instance of one of the following classes: String, Integer, or Boolean. If the value is null, the attribute is considered to be undefined.

Parameters:
attributeName - the name of the attribute
value - the value, or null if the attribute is to be undefined

setAttribute

void setAttribute(
String attributeName,
                  boolean value)
Sets the boolean-valued attribute with the given name.

Parameters:
attributeName - the name of the attribute
value - the value

setAttributes

void setAttributes(
String[] attributeNames,
                   
Object[] values)
Sets the given attribute key-value pairs on this marker. The values must be null or an instance of one of the following classes: String, Integer, or Boolean. If a value is null, the new value of the attribute is considered to be undefined.

Parameters:
attributeNames - an array of attribute names
values - an array of attribute values

setAttributes

void setAttributes(
Map attributes)
Sets the attributes for this marker to be the ones contained in the given table. The values must be an instance of one of the following classes: String, Integer, or Boolean. Attributes previously set on the marker but not included in the given map are considered to be removals. Setting the given map to be null is equivalent to removing all marker attributes.

Parameters:
attributes - a map of attribute names to attribute values (key type : String value type : String, Integer, or Boolean) or null

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire