org.apache.maven.diagrams.connector_api
Interface DiagramConnector

public interface DiagramConnector

Interface for all connector's

Author:

ptab

Method Summary

org.apache.maven.diagrams.graph_api.Graph	calculateGraph(ConnectorConfiguration configuration) If the connector supports the "Static interface" (ConnectorInterfaceEnum.STATIC) the method should return calculated graph.
ConnectorDescriptor	getConnectorDescriptor() Returns connector's descriptor.
DynamicDiagramConnector	getDynamicDiagramConnector() If the connector supports the "Dynamic interface / Listener model" (ConnectorInterfaceEnum.Dynamic) the method should return DynamicDiagramConnector (for the Listening management - not thread safe, for single thread use only)
void	setMavenProject(org.apache.maven.project.MavenProject mavenProject)

Method Detail

calculateGraph

org.apache.maven.diagrams.graph_api.Graph calculateGraph(ConnectorConfiguration configuration)
                                                         throws ConnectorException

If the connector supports the "Static interface" (ConnectorInterfaceEnum.STATIC) the method should return calculated graph. It returns null otherwise

Parameters:

configuration -

Returns:

Throws:

ConnectorException

getDynamicDiagramConnector

DynamicDiagramConnector getDynamicDiagramConnector()
                                                   throws ConnectorException

If the connector supports the "Dynamic interface / Listener model" (ConnectorInterfaceEnum.Dynamic) the method should return DynamicDiagramConnector (for the Listening management - not thread safe, for single thread use only)

Parameters:

configuration -

Returns:

Throws:

ConnectorException

getConnectorDescriptor

ConnectorDescriptor getConnectorDescriptor()
                                           throws ConnectorException

Returns connector's descriptor.

Throws:

ConnectorException

setMavenProject

void setMavenProject(org.apache.maven.project.MavenProject mavenProject)