com.ibm.ftt.resources.core
Interface IMarkerFactory

All Known Implementing Classes:
MarkerFactory

public interface IMarkerFactory

A factory for creating and removing the appropriate markers against the remote resource. This is useful for adding or removing error, warning or information messages for the specified resource.


Field Summary
static String COPY_RIGHT
           
static IMarkerFactory eINSTANCE
           
 
Method Summary
 void createMarker(Object resource, String msg, String id, int severity, int lineNumber)
          Creates a marker on the remote error list.
 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

static final String COPY_RIGHT
See Also:
Constant Field Values

eINSTANCE

static final IMarkerFactory eINSTANCE
Method Detail

createMarker

void createMarker(Object resource,
                  String msg,
                  String id,
                  int severity,
                  int lineNumber)
                  throws IllegalArgumentException
Creates a marker on the remote error list.

Parameters:
resource - resource to create the marker against
msg - message associated with the error marker
id - ID of the message
severity - severity of the message. can be IMarker.SEVERITY_INFO, IMarker.SEVERITY_WARNING, or IMarker.SEVERITY_ERROR.
lineNumber - line number associated with the resource
Throws:
IllegalArgumentException

removeMarkers

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

Parameters:
resource - resource of interest

getAllMarkers

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

Returns:
an array of markers

deleteAllMarkers

void deleteAllMarkers()
Deletes all markers on the remote error list