com.ibm.ftt.resources.core.factory
Class MarkerFactory

java.lang.Object
  extended by com.ibm.ftt.resources.core.factory.MarkerFactory
All Implemented Interfaces:
IMarkerFactory

public class MarkerFactory
extends Object
implements IMarkerFactory

The MarkerFactory can be used to attach and manage error, warning and informational messages associated with a given resource. These messages are intended to be displayed for the Remote Error List View.


Field Summary
static String COPY_RIGHT
           
 
Fields inherited from interface com.ibm.ftt.resources.core.IMarkerFactory
eINSTANCE
 
Constructor Summary
MarkerFactory()
           
 
Method Summary
 void createMarker(Object resource, String msg, String id, int severity, int lineNumber)
          Creates a marker associating the specified message with the given resource at the specified line number.
 void deleteAllMarkers()
          Deletes all markers on the remote error list
 org.eclipse.core.resources.IMarker[] getAllMarkers()
          Returns all markers that are available on the remote error list.
 void removeMarkers(Object resource)
          Removes all the markers that are associated with the specified resource.
 

Field Detail

COPY_RIGHT

public static final String COPY_RIGHT
See Also:
Constant Field Values
Constructor Detail

MarkerFactory

public MarkerFactory()
Method Detail

createMarker

public void createMarker(Object resource,
                         String msg,
                         String id,
                         int severity,
                         int lineNumber)
Creates a marker associating the specified message with the given resource at the specified line number.

Specified by:
createMarker in interface IMarkerFactory
Parameters:
resource - an Object representing the resource for which a marker is to be created
msg - a string containing the text to be associated with the resource
id - a string containing the id of the marker
severity - the severity of the message to be placed in the marker .. can be IMarker.SEVERITY_INFO, IMarker.SEVERITY_WARNING, IMarker.SEVERITY_ERROR
lineNumber - the line number of the source file associated with the marker

removeMarkers

public void removeMarkers(Object resource)
Removes all the markers that are associated with the specified resource.

Specified by:
removeMarkers in interface IMarkerFactory
Parameters:
resource - an Object representing the resource for which markers are to be removed

deleteAllMarkers

public void deleteAllMarkers()
Description copied from interface: IMarkerFactory
Deletes all markers on the remote error list

Specified by:
deleteAllMarkers in interface IMarkerFactory

getAllMarkers

public org.eclipse.core.resources.IMarker[] getAllMarkers()
Description copied from interface: IMarkerFactory
Returns all markers that are available on the remote error list. Returns an empty array if there are no matching markers.

Specified by:
getAllMarkers in interface IMarkerFactory
Returns:
an array of markers