|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final String EXTENSION_POINT_ID
Method Detail |
---|
void delete()
boolean equals(Object object)
equals
in class Object
object
- the other object
true
if objects are equal, false
otherwiseboolean exists()
true
if this marker exists, otherwise
false
Object getAttribute(String attributeName)
String
, Integer
,
or Boolean
.
Returns null
if the attribute is undefined.
attributeName
- the name of the attribute
null
if the attribute is undefined.int getAttribute(String attributeName, int defaultValue)
attributeName
- the name of the attributedefaultValue
- the value to use if no value is found
String getAttribute(String attributeName, String defaultValue)
attributeName
- the name of the attributedefaultValue
- the value to use if no value is found
boolean getAttribute(String attributeName, boolean defaultValue)
attributeName
- the name of the attributedefaultValue
- the value to use if no value is found
Map getAttributes()
null
is returned.
String
value type : String
, Integer
, or
Boolean
) or null
.Object[] getAttributes(String[] attributeNames)
null
or an instance of one
of the following classes: String
, Integer
,
or Boolean
.
attributeNames
- the names of the attributes
long getCreationTime()
long getId()
ISystemRemoteResource.findMarker(long)
ISystemRemoteResource getResource()
String getType()
boolean isSubtypeOf(String superType)
true
if the marker's type
is the same as (or a subtype of) the given type.void setAttribute(String attributeName, int value)
attributeName
- the name of the attributevalue
- the valuevoid setAttribute(String attributeName, Object value)
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.
attributeName
- the name of the attributevalue
- the value, or null
if the attribute is to be undefinedvoid setAttribute(String attributeName, boolean value)
attributeName
- the name of the attributevalue
- the valuevoid setAttributes(String[] attributeNames, Object[] values)
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.
attributeNames
- an array of attribute namesvalues
- an array of attribute valuesvoid setAttributes(Map attributes)
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.
attributes
- a map of attribute names to attribute values
(key type : String
value type : String
,
Integer
, or Boolean
) or null
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |