Package ch.sahits.game.openpatrician.app.documentation

Class ClassJavaDocFirstSentenceScanner

  • All Implemented Interfaces:
    com.sun.source.tree.TreeVisitor<java.lang.Object,​com.sun.source.util.Trees>
    public class ClassJavaDocFirstSentenceScanner
extends com.sun.source.util.TreePathScanner<java.lang.Object,​com.sun.source.util.Trees>
    Scanner to extract the first sentence of the class javadoc.
    Author:
    Andi Hotz, (c) Sahits GmbH, 2018 Created on Apr 07, 2018

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String javaDocSentence  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void findJavaDocSentence​(com.sun.source.tree.CompilationUnitTree node)  
      java.lang.String getJavaDocSentence()  
      java.lang.Object visitCompilationUnit​(com.sun.source.tree.CompilationUnitTree node, com.sun.source.util.Trees trees)  

      • Methods inherited from class com.sun.source.util.TreePathScanner

        getCurrentPath, scan, scan

      • Methods inherited from class com.sun.source.util.TreeScanner

        reduce, scan, visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompoundAssignment, visitConditionalExpression, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitModule, visitNewArray, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnary, visitUnionType, visitUses, visitVariable, visitWhileLoop, visitWildcard

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • javaDocSentence

        private java.lang.String javaDocSentence

    • Constructor Detail

      • ClassJavaDocFirstSentenceScanner

        public ClassJavaDocFirstSentenceScanner()

    • Method Detail

      • visitCompilationUnit

        public java.lang.Object visitCompilationUnit​(com.sun.source.tree.CompilationUnitTree node,
                                             com.sun.source.util.Trees trees)
        Specified by:
        visitCompilationUnit in interface com.sun.source.tree.TreeVisitor<java.lang.Object,​com.sun.source.util.Trees>
        Overrides:
        visitCompilationUnit in class com.sun.source.util.TreeScanner<java.lang.Object,​com.sun.source.util.Trees>

      • getJavaDocSentence

        public java.lang.String getJavaDocSentence()

      • findJavaDocSentence

        private void findJavaDocSentence​(com.sun.source.tree.CompilationUnitTree node)