metricsOverlay.api
Class MetricOverlayAPI

java.lang.Object
  extended by metricsOverlay.api.MetricOverlayAPI
All Implemented Interfaces:
java.util.Observer, IMetricOverlay

public class MetricOverlayAPI
extends java.lang.Object
implements IMetricOverlay


Method Summary
 MetricDocument createMetricDocument(org.eclipse.core.runtime.IPath fileName)
          Creates a metric document for a specific file.
 MetricDocument createMetricDocument(java.lang.String fileName)
          Creates a metric document for a specific file.
 void update(java.util.Observable arg0, java.lang.Object arg1)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

update

public void update(java.util.Observable arg0,
                   java.lang.Object arg1)
Specified by:
update in interface java.util.Observer

createMetricDocument

public MetricDocument createMetricDocument(java.lang.String fileName)
Description copied from interface: IMetricOverlay
Creates a metric document for a specific file.

Specified by:
createMetricDocument in interface IMetricOverlay
Parameters:
fileName - a String representation of the underlying file's path and name. The path should be an absolute representation.
Returns:
an empty MetricDocument for a specific file.

createMetricDocument

public MetricDocument createMetricDocument(org.eclipse.core.runtime.IPath fileName)
Description copied from interface: IMetricOverlay
Creates a metric document for a specific file.

Specified by:
createMetricDocument in interface IMetricOverlay
Parameters:
fileName - an IPath representation of the file's path and name.
Returns:
an empty MetricDocument for a specific file.