Package ch.sahits.game.openpatrician.app.display

Class DocumentationUtility

  • Direct Known Subclasses:
    SpringClassFinder, TodoLister
    public abstract class DocumentationUtility
extends java.lang.Object
    Author:
    Andi Hotz, (c) Sahits GmbH, 2014 Created on Nov 18, 2014

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String JAVA_SOURCE  
      protected java.io.File rootDirectory  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected DocumentationUtility()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract java.lang.String createOutput()  
      protected java.util.List<java.io.File> findJavaFilesIn​(java.io.File dir)
      Find all the java files under a sub directory.
      protected java.util.List<java.lang.String> getModuleNames()
      Retrieve the Maven module names from the pom.xml in the root directory.
      protected java.lang.String getTypeFromFilePath​(int length, java.io.File javaFile)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • rootDirectory

        protected java.io.File rootDirectory

    • Constructor Detail

      • DocumentationUtility

        protected DocumentationUtility()

    • Method Detail

      • createOutput

        protected abstract java.lang.String createOutput()

      • getModuleNames

        protected java.util.List<java.lang.String> getModuleNames()
        Retrieve the Maven module names from the pom.xml in the root directory.
        Returns:
        List of module names

      • findJavaFilesIn

        protected java.util.List<java.io.File> findJavaFilesIn​(java.io.File dir)
        Find all the java files under a sub directory.
        Parameters:
        dir - directory to look in
        Returns:
        List of Java files in dir

      • getTypeFromFilePath

        protected java.lang.String getTypeFromFilePath​(int length,
                                               java.io.File javaFile)