metricsOverlay.api
Interface IMetricOverlay

All Superinterfaces:
java.util.Observer
All Known Implementing Classes:
MetricOverlayAPI

public interface IMetricOverlay
extends java.util.Observer

The interface to the program's main API. Calling these methods allows an extension to this plug-in to provide live metric data.

Version:
1/7/2009
Author:
Matthew Harward

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.
 
Methods inherited from interface java.util.Observer
update
 

Method Detail

createMetricDocument

MetricDocument createMetricDocument(java.lang.String fileName)
Creates a metric document for a specific file.

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

MetricDocument createMetricDocument(org.eclipse.core.runtime.IPath fileName)
Creates a metric document for a specific file.

Parameters:
fileName - an IPath representation of the file's path and name.
Returns:
an empty MetricDocument for a specific file.