Class DocumentModelBuilder


  • public class DocumentModelBuilder
    extends Object
    Construct a DocumentModel from a MavenProject and related information.
    Author:
    ltheussl
    • Constructor Detail

      • DocumentModelBuilder

        public DocumentModelBuilder​(org.apache.maven.project.MavenProject project)
        Constructor. Initialize a MavenProject to extract information from.
        Parameters:
        project - a MavenProject. May be null.
      • DocumentModelBuilder

        public DocumentModelBuilder​(org.apache.maven.project.MavenProject project,
                                    org.apache.maven.doxia.site.decoration.DecorationModel decorationModel)
        Constructor. Initialize a MavenProject and a DecorationModel to extract information from.
        Parameters:
        project - a MavenProject. May be null.
        decorationModel - a DecorationModel. May be null.
    • Method Detail

      • getDocumentModel

        public org.apache.maven.doxia.document.DocumentModel getDocumentModel()
        Get a DocumentModel.
        Returns:
        a DocumentModel. Always non-null.
      • getDocumentModel

        public org.apache.maven.doxia.document.DocumentModel getDocumentModel​(Date date)
        Get a DocumentModel.
        Parameters:
        date - overrides the default date in meta- and cover information.
        Returns:
        a DocumentModel. Always non-null.