Package org.eclipse.tycho.extras.docbundle

Class TocWriter

  • public class TocWriter
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.File basedir  
      private java.io.File javadocDir  
      private org.apache.maven.plugin.logging.Log log  
      private TocOptions options  

    • Constructor Summary

      Constructors 
      Constructor Description
      TocWriter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private org.w3c.dom.Element createTopic​(org.w3c.dom.Document doc, org.w3c.dom.Element parent, java.lang.String label, java.lang.String fileName)  
      private void fillDocument​(org.w3c.dom.Document doc, java.io.File tocFile)  
      private java.lang.String makeRelative​(java.io.File base, java.io.File file)  
      private void process​(java.io.File tocFile)  
      void setBasedir​(java.io.File basedir)  
      void setJavadocDir​(java.io.File javadocDir)  
      void setLog​(org.apache.maven.plugin.logging.Log log)  
      void setOptions​(TocOptions options)  
      void writeTo​(java.io.File tocFile)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • javadocDir

        private java.io.File javadocDir

      • basedir

        private java.io.File basedir

      • log

        private org.apache.maven.plugin.logging.Log log

    • Constructor Detail

      • TocWriter

        public TocWriter()

    • Method Detail

      • setLog

        public void setLog​(org.apache.maven.plugin.logging.Log log)

      • setBasedir

        public void setBasedir​(java.io.File basedir)

      • setJavadocDir

        public void setJavadocDir​(java.io.File javadocDir)

      • setOptions

        public void setOptions​(TocOptions options)

      • writeTo

        public void writeTo​(java.io.File tocFile)
             throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • process

        private void process​(java.io.File tocFile)
              throws java.lang.Exception
        Throws:
        java.lang.Exception

      • fillDocument

        private void fillDocument​(org.w3c.dom.Document doc,
                          java.io.File tocFile)
                   throws java.lang.Exception
        Throws:
        java.lang.Exception

      • createTopic

        private org.w3c.dom.Element createTopic​(org.w3c.dom.Document doc,
                                        org.w3c.dom.Element parent,
                                        java.lang.String label,
                                        java.lang.String fileName)
                                 throws org.w3c.dom.DOMException,
                                        java.io.IOException
        Throws:
        org.w3c.dom.DOMException
        java.io.IOException

      • makeRelative

        private java.lang.String makeRelative​(java.io.File base,
                                      java.io.File file)
                               throws java.io.IOException
        Throws:
        java.io.IOException