org.apache.maven.diagrams.connector_api.descriptor
Interface ConnectorDescriptor

All Known Implementing Classes:
DefaultConnectorDescriptor

public interface ConnectorDescriptor


Method Summary
 DiagramConnector createConnectorInstance()
           
 java.lang.String getArtifactId()
           
 java.lang.Class<? extends ConnectorConfiguration> getConfigurationClass()
          The method returns the ConnectorConfiguration class that the connector use.
 java.lang.String getDescription()
           
 java.lang.String getGroupId()
           
 java.util.List<Mapping> getMappings()
          It return set of mappings "tag name to class" used by xstream library to serialize and deserialize ConnectorConfiguration
 java.lang.String getName()
           
 ConnectorInterfaceEnum getPreferredInterface()
          Return which type of interface to the described connector (static or dynamic) should be preferred by libraries using the connector.
 java.util.EnumSet<ConnectorInterfaceEnum> getProvidedInterfaces()
           
 java.lang.String getVersion()
           
 void setArtifactId(java.lang.String artifactId)
           
 void setConfigurationClass(java.lang.Class<? extends ConnectorConfiguration> configurationClass)
          The method sets the ConnectorConfiguration class that the connector use.
 void setDescription(java.lang.String description)
           
 void setGroupId(java.lang.String groupId)
           
 void setMappings(java.util.List<Mapping> mappings)
          It sets mappings "tag name to class" used by xstream library to serialize and deserialize ConnectorConfiguration
 void setName(java.lang.String name)
           
 void setPreferredInterface(ConnectorInterfaceEnum preferredInterface)
          Sets the preferred interface.
 void setProvidedInterfaces(java.util.EnumSet<ConnectorInterfaceEnum> providedInterfaces)
           
 void setVersion(java.lang.String version)
           
 

Method Detail

createConnectorInstance

DiagramConnector createConnectorInstance()
                                         throws ConnectorException
Throws:
ConnectorException

getGroupId

java.lang.String getGroupId()

setGroupId

void setGroupId(java.lang.String groupId)

getArtifactId

java.lang.String getArtifactId()

setArtifactId

void setArtifactId(java.lang.String artifactId)

getVersion

java.lang.String getVersion()

setVersion

void setVersion(java.lang.String version)

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String description)

getProvidedInterfaces

java.util.EnumSet<ConnectorInterfaceEnum> getProvidedInterfaces()

setProvidedInterfaces

void setProvidedInterfaces(java.util.EnumSet<ConnectorInterfaceEnum> providedInterfaces)

getPreferredInterface

ConnectorInterfaceEnum getPreferredInterface()
Return which type of interface to the described connector (static or dynamic) should be preferred by libraries using the connector. It have to be one of interfaces returned by getProvidedInterfaces

Returns:
preferred interface type.

setPreferredInterface

void setPreferredInterface(ConnectorInterfaceEnum preferredInterface)
Sets the preferred interface.

Parameters:
preferredInterface -

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getConfigurationClass

java.lang.Class<? extends ConnectorConfiguration> getConfigurationClass()
The method returns the ConnectorConfiguration class that the connector use.

Returns:
the class implementing ConnectorConfiguration

setConfigurationClass

void setConfigurationClass(java.lang.Class<? extends ConnectorConfiguration> configurationClass)
The method sets the ConnectorConfiguration class that the connector use.

Parameters:
configurationClass - to set.

getMappings

java.util.List<Mapping> getMappings()
It return set of mappings "tag name to class" used by xstream library to serialize and deserialize ConnectorConfiguration

Returns:

setMappings

void setMappings(java.util.List<Mapping> mappings)
It sets mappings "tag name to class" used by xstream library to serialize and deserialize ConnectorConfiguration

Parameters:
mappings - to be set


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.