com.sun.enterprise.build
Interface DistributionVisitor

All Known Implementing Classes:

ContributorsWikiGenerator, DashboardWikiGenerator

public interface DistributionVisitor

Interface to create the dashboard, implementation are rendering specifics (html, wiki) Each instance is not thread-safe.

Author:

Jerome Dochez

Method Summary

void	addDevelopers(List<org.apache.maven.model.Developer> devs) Adds the list of developers of the module
void	addImportedBy(List<org.apache.maven.artifact.Artifact> importers) Adds the list of modules importing the current module
void	addImports(List<org.apache.maven.model.Dependency> dependencies) Adds the list of imported modules by this module
void	addLicenses(List<org.apache.maven.model.License> licenses) Adds the licenses governing the module
void	addMailingLists(List<org.apache.maven.model.MailingList> lists) Adds the list of mailing-lists associated with the module
void	addRepository(org.apache.maven.artifact.repository.ArtifactRepository repository) Adds the module's repository
void	addSCM(org.apache.maven.model.Scm scm) Adds the source code management information
void	addSize(long size) Adds the module's size
void	beginArtifact(org.apache.maven.artifact.Artifact artifact) Start a new module/library artifact.
void	beginCategory(String categoryName) Start a new category for the dashboard, usually this is represented by a separate table but the underlying format will decide.
void	beginDistribution(PrintWriter writer, org.apache.maven.project.MavenProject distribution) Sets the writer associated with his generator
void	beginGroup(String groupName, boolean inTable) Start a new group of modules or librairies.
void	endArtifact() End of the current module's model
void	endCategory() End of the current category
void	endDistribution() End of the distribution
void	endGroup() End of the current group

Method Detail

beginDistribution

void beginDistribution(PrintWriter writer,
                       org.apache.maven.project.MavenProject distribution)

Sets the writer associated with his generator

Parameters:

writer - the writer associated with this generator

distribution - the distribution's project

beginCategory

void beginCategory(String categoryName)

Start a new category for the dashboard, usually this is represented by a separate table but the underlying format will decide.

Parameters:

categoryName - name of the new category

beginGroup

void beginGroup(String groupName,
                boolean inTable)

Start a new group of modules or librairies.

Parameters:

groupName - the new group name

inTable - true if the group should be displayed as a column or as a subtitle.

beginArtifact

void beginArtifact(org.apache.maven.artifact.Artifact artifact)

Start a new module/library artifact.

Parameters:

artifact - artifact for the module

addSize

void addSize(long size)

Adds the module's size

Parameters:

size - module's size

addRepository

void addRepository(org.apache.maven.artifact.repository.ArtifactRepository repository)

Adds the module's repository

Parameters:

repository - module's repository

addDevelopers

void addDevelopers(List<org.apache.maven.model.Developer> devs)

Adds the list of developers of the module

Parameters:

devs - module's developers

addMailingLists

void addMailingLists(List<org.apache.maven.model.MailingList> lists)

Adds the list of mailing-lists associated with the module

Parameters:

lists - mailing-lists for the module

addImports

void addImports(List<org.apache.maven.model.Dependency> dependencies)

Adds the list of imported modules by this module

Parameters:

dependencies - module's dependencies

addImportedBy

void addImportedBy(List<org.apache.maven.artifact.Artifact> importers)

Adds the list of modules importing the current module

Parameters:

importers - module's importers

addSCM

void addSCM(org.apache.maven.model.Scm scm)

Adds the source code management information

Parameters:

scm - module's SCM

addLicenses

void addLicenses(List<org.apache.maven.model.License> licenses)

Adds the licenses governing the module

Parameters:

licenses - module's licenses

endArtifact

void endArtifact()

End of the current module's model

endGroup

void endGroup()

End of the current group

endCategory

void endCategory()

End of the current category

endDistribution

void endDistribution()

End of the distribution