com.sun.enterprise.build
Class DashboardWikiGenerator

java.lang.Object
  com.sun.enterprise.build.DashboardWikiGenerator

All Implemented Interfaces:

DistributionVisitor

public class DashboardWikiGenerator
extends Object
implements DistributionVisitor

Field Summary

protected Pattern

scmURLPattern

Constructor Summary

DashboardWikiGenerator()

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> mailingLists) 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
protected String	getSCMSpecficPart(String scmConnection)
protected String	getSCMType(String scmConnection)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

scmURLPattern

protected final Pattern scmURLPattern

Constructor Detail

DashboardWikiGenerator

public DashboardWikiGenerator()

Method Detail

beginDistribution

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

Sets the writer associated with his generator

Specified by:

beginDistribution in interface DistributionVisitor

Parameters:

writer - the writer associated with this generator

distribution - the distribution's project

beginCategory

public 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.

Specified by:

beginCategory in interface DistributionVisitor

Parameters:

categoryName - name of the new category

beginGroup

public void beginGroup(String groupName,
                       boolean inTable)

Start a new group of modules or librairies.

Specified by:

beginGroup in interface DistributionVisitor

Parameters:

groupName - the new group name

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

beginArtifact

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

Start a new module/library artifact.

Specified by:

beginArtifact in interface DistributionVisitor

Parameters:

artifact - artifact for the module

addSize

public void addSize(long size)

Adds the module's size

Specified by:

addSize in interface DistributionVisitor

Parameters:

size - module's size

addRepository

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

Adds the module's repository

Specified by:

addRepository in interface DistributionVisitor

Parameters:

repository - module's repository

addDevelopers

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

Adds the list of developers of the module

Specified by:

addDevelopers in interface DistributionVisitor

Parameters:

devs - module's developers

addMailingLists

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

Adds the list of mailing-lists associated with the module

Specified by:

addMailingLists in interface DistributionVisitor

Parameters:

mailingLists - mailing-lists for the module

addImports

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

Adds the list of imported modules by this module

Specified by:

addImports in interface DistributionVisitor

Parameters:

dependencies - module's dependencies

addImportedBy

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

Adds the list of modules importing the current module

Specified by:

addImportedBy in interface DistributionVisitor

Parameters:

importers - module's importers

addSCM

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

Adds the source code management information

Specified by:

addSCM in interface DistributionVisitor

Parameters:

scm - module's SCM

addLicenses

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

Adds the licenses governing the module

Specified by:

addLicenses in interface DistributionVisitor

Parameters:

licenses - module's licenses

endArtifact

public void endArtifact()

End of the current module's model

Specified by:

endArtifact in interface DistributionVisitor

endGroup

public void endGroup()

End of the current group

Specified by:

endGroup in interface DistributionVisitor

endCategory

public void endCategory()

End of the current category

Specified by:

endCategory in interface DistributionVisitor

endDistribution

public void endDistribution()

End of the distribution

Specified by:

endDistribution in interface DistributionVisitor

getSCMType

protected String getSCMType(String scmConnection)

getSCMSpecficPart

protected String getSCMSpecficPart(String scmConnection)