Remote Systems
v6.4.1

com.ibm.etools.systems.core.resources
Class SystemRemoteMarkerManager

java.lang.Object
  extended bycom.ibm.etools.systems.core.resources.SystemRemoteMarkerManager
All Implemented Interfaces:
ISystemRemoteManager

public class SystemRemoteMarkerManager
extends Object
implements ISystemRemoteManager

This singleton class manages all remote markers.


Field Summary
static String Copyright
           
 
Method Summary
 void add(ISystemRemoteResource resource, SystemRemoteMarkerInfo[] newMarkers)
          Adds the given markers to the given resource.
 ISystemRemoteMarker findMarker(ISystemRemoteResource resource, long id)
          Returns the marker with the given id or null if none is found.
 SystemRemoteMarkerInfo findMarkerInfo(ISystemRemoteResource resource, long id)
          Finds a marker info given a resource, and the marker id.
 ISystemRemoteMarker[] findMarkers(ISystemRemoteResource resource, String type, boolean includeSubtypes)
          Returns all markers of the specified type on the given target, and optionally the subtypes as well.
 SystemRemoteMarkerTypeDefinitionCache getCache()
          Get the cache.
static SystemRemoteMarkerManager getInstance()
          Get the singleton instance.
 long getNextMarkerId()
          Get the next marker id.
 boolean isPersistent(ISystemRemoteMarker marker)
          Returns whether given marker is persistent.
 boolean isPersistent(SystemRemoteMarkerInfo info)
          Returns whether marker info is persistent.
 boolean isPersistent(SystemRemoteMarkerInfo[] infos)
          Returns whether any of the marker infos are persistent.
 void removeMarker(ISystemRemoteResource resource, long id)
          Removes a marker.
 void removeMarkers(ISystemRemoteResource resource, String type, boolean includeSubtypes)
          Removes markers of the given type, and optionally all the subtypes, from the given resource.
 void shutdown(IProgressMonitor monitor)
          This method is called during plugin shutdown.
 void startup(IProgressMonitor monitor)
          This method is called during plugin startup.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Method Detail

getInstance

public static SystemRemoteMarkerManager getInstance()
Get the singleton instance.

Returns:
the manager object

getCache

public SystemRemoteMarkerTypeDefinitionCache getCache()
Get the cache.

Returns:
the cache

getNextMarkerId

public long getNextMarkerId()
Get the next marker id.

Returns:
the next marker id

add

public void add(ISystemRemoteResource resource,
                SystemRemoteMarkerInfo[] newMarkers)
Adds the given markers to the given resource.


removeMarker

public void removeMarker(ISystemRemoteResource resource,
                         long id)
Removes a marker.


findMarkerInfo

public SystemRemoteMarkerInfo findMarkerInfo(ISystemRemoteResource resource,
                                             long id)
Finds a marker info given a resource, and the marker id.

Returns:
the marker info

removeMarkers

public void removeMarkers(ISystemRemoteResource resource,
                          String type,
                          boolean includeSubtypes)
Removes markers of the given type, and optionally all the subtypes, from the given resource.


findMarker

public ISystemRemoteMarker findMarker(ISystemRemoteResource resource,
                                      long id)
Returns the marker with the given id or null if none is found.

Returns:
the marker, or null if none s found.

findMarkers

public ISystemRemoteMarker[] findMarkers(ISystemRemoteResource resource,
                                         String type,
                                         boolean includeSubtypes)
Returns all markers of the specified type on the given target, and optionally the subtypes as well. Passing null for the type specifies a matching target for all types.


isPersistent

public boolean isPersistent(SystemRemoteMarkerInfo info)
Returns whether marker info is persistent.

Returns:
true if the given marker represented by this info is persistent, and false otherwise.

isPersistent

public boolean isPersistent(ISystemRemoteMarker marker)
Returns whether given marker is persistent.

Returns:
true if the given marker is persistent, and false otherwise.

isPersistent

public boolean isPersistent(SystemRemoteMarkerInfo[] infos)
Returns whether any of the marker infos are persistent.

Returns:
true if the a marker represented by any of the infos is persistent, and false otherwise.

startup

public void startup(IProgressMonitor monitor)
Description copied from interface: ISystemRemoteManager
This method is called during plugin startup.

Specified by:
startup in interface ISystemRemoteManager
See Also:
ISystemRemoteManager.startup(IProgressMonitor)

shutdown

public void shutdown(IProgressMonitor monitor)
Description copied from interface: ISystemRemoteManager
This method is called during plugin shutdown.

Specified by:
shutdown in interface ISystemRemoteManager
See Also:
ISystemRemoteManager.shutdown(IProgressMonitor)

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.