Class JavaSnippetReader


  • class JavaSnippetReader
    extends SnippetReader
    A snippet readers for the Java language.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private com.github.javaparser.JavaParser _parser  
      private com.github.javaparser.printer.PrettyPrinterConfiguration _printConf  
      private static java.util.regex.Pattern snippetPattern  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private java.lang.String cleanupConfig​(java.lang.String unparsedConfig)  
      private Snippet createSnippet​(java.lang.String id, JavaSnippetReader.CodeSnippetConfig config, java.util.function.Supplier<java.lang.String> formatedCode)  
      private java.lang.String formatCode​(com.github.javaparser.ast.CompilationUnit cu, com.github.javaparser.ast.body.MethodDeclaration node, boolean showImport, boolean showDeclaration)  
      private java.lang.String formatCode​(com.github.javaparser.ast.CompilationUnit cu, com.github.javaparser.ast.body.TypeDeclaration<?> node, boolean showImport, boolean showDeclaration)  
      private java.lang.String formatComment​(java.lang.String commentContent)  
      private void formatImports​(java.lang.StringBuilder sb, com.github.javaparser.ast.CompilationUnit cu)  
      private void formatMethodNoDeclaration​(java.lang.StringBuilder sb, com.github.javaparser.ast.body.MethodDeclaration node)  
      private void formatTypeNoDeclaration​(java.lang.StringBuilder sb, com.github.javaparser.ast.body.TypeDeclaration<?> node)  
      private boolean isLegalConfig​(java.lang.String unparsedConfig)  
      private java.util.List<JavaSnippetReader.CodeSnippetConfig> parseSnippetConfig​(com.github.javaparser.ast.comments.Comment comment)  
      java.util.List<Snippet> read​(java.io.File file)
      Read a file and extract snippets from it.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • snippetPattern

        private static final java.util.regex.Pattern snippetPattern
      • _parser

        private final com.github.javaparser.JavaParser _parser
      • _printConf

        private final com.github.javaparser.printer.PrettyPrinterConfiguration _printConf
    • Constructor Detail

      • JavaSnippetReader

        JavaSnippetReader()
    • Method Detail

      • read

        public java.util.List<Snippet> read​(java.io.File file)
                                     throws java.io.FileNotFoundException
        Description copied from class: SnippetReader
        Read a file and extract snippets from it.
        Specified by:
        read in class SnippetReader
        Parameters:
        file - the file to analyze
        Returns:
        an ordered list of snippets
        Throws:
        java.io.FileNotFoundException
      • formatCode

        private java.lang.String formatCode​(com.github.javaparser.ast.CompilationUnit cu,
                                            com.github.javaparser.ast.body.TypeDeclaration<?> node,
                                            boolean showImport,
                                            boolean showDeclaration)
      • formatTypeNoDeclaration

        private void formatTypeNoDeclaration​(java.lang.StringBuilder sb,
                                             com.github.javaparser.ast.body.TypeDeclaration<?> node)
      • formatCode

        private java.lang.String formatCode​(com.github.javaparser.ast.CompilationUnit cu,
                                            com.github.javaparser.ast.body.MethodDeclaration node,
                                            boolean showImport,
                                            boolean showDeclaration)
      • formatMethodNoDeclaration

        private void formatMethodNoDeclaration​(java.lang.StringBuilder sb,
                                               com.github.javaparser.ast.body.MethodDeclaration node)
      • formatImports

        private void formatImports​(java.lang.StringBuilder sb,
                                   com.github.javaparser.ast.CompilationUnit cu)
      • isLegalConfig

        private boolean isLegalConfig​(java.lang.String unparsedConfig)
      • cleanupConfig

        private java.lang.String cleanupConfig​(java.lang.String unparsedConfig)
      • formatComment

        private java.lang.String formatComment​(java.lang.String commentContent)