Package com.github.tadukoo.java.parsing.comment

Class JavaSingleLineCommentParser

java.lang.Object

com.github.tadukoo.java.parsing.AbstractJavaParser

com.github.tadukoo.java.parsing.comment.JavaSingleLineCommentParser

All Implemented Interfaces:

JavaTokens

public class JavaSingleLineCommentParser
extends AbstractJavaParser

A parser to use for parsing single-line Java comments

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields inherited from class com.github.tadukoo.java.parsing.AbstractJavaParser

MODIFIERS_REGEX, PARAMETER_PATTERN, PARAMETER_REGEX, TOKEN_REGEX, TYPE_PARAMETER_PATTERN, TYPE_PARAMETER_REGEX, TYPE_PATTERN, TYPE_REGEX, WHITESPACE_MATCHER

Fields inherited from interface com.github.tadukoo.java.JavaTokens

ABSTRACT_MODIFIER, ANNOTATION_START_TOKEN, ASSIGNMENT_OPERATOR_TOKEN, BLOCK_CLOSE_TOKEN, BLOCK_OPEN_TOKEN, CLASS_TOKEN, EXTENDS_TOKEN, FINAL_MODIFIER, IMPLEMENTS_TOKEN, IMPORT_TOKEN, JAVADOC_AUTHOR_TOKEN, JAVADOC_LINE_TOKEN, JAVADOC_PARAM_TOKEN, JAVADOC_RETURN_TOKEN, JAVADOC_SINCE_TOKEN, JAVADOC_START_TOKEN, JAVADOC_VERSION_TOKEN, LIST_SEPARATOR_TOKEN, MODIFIERS, MULTI_LINE_COMMENT_CLOSE_TOKEN, MULTI_LINE_COMMENT_START_TOKEN, PACKAGE_TOKEN, PARAMETER_CLOSE_TOKEN, PARAMETER_OPEN_TOKEN, PRIVATE_MODIFIER, PROTECTED_MODIFIER, PUBLIC_MODIFIER, SEMICOLON, SINGLE_LINE_COMMENT_TOKEN, STATIC_MODIFIER, THROWS_TOKEN, TYPE_PARAMETER_CLOSE_TOKEN, TYPE_PARAMETER_OPEN_TOKEN, VARARGS_TOKEN, VISIBILITY_MODIFIERS

Method Summary

Modifier and Type	Method	Description
static JavaSingleLineComment	parseSingleLineComment(String content)	Parses a single-line comment from the given content String
static ParsingPojo	parseSingleLineComment(List<String> tokens, int startToken)	Parses a single-line comment from the given tokens and starting index

Methods inherited from class com.github.tadukoo.java.parsing.AbstractJavaParser

determineFieldOrMethod, parseJavaParameter, parseJavaType, parseJavaTypeParameters, parseOutType, skipLeadingWhitespace, splitContentIntoTokens, verifyEndOfTokens

Methods inherited from class java.lang.Object

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

Method Details

parseSingleLineComment

public static JavaSingleLineComment parseSingleLineComment(String content)
                                                    throws JavaParsingException

Parses a single-line comment from the given content String

Parameters:

content - The String to be parsed as a single-line comment

Returns:

The parsed single-line comment

Throws:

JavaParsingException - If anything goes wrong in parsing

parseSingleLineComment

public static ParsingPojo parseSingleLineComment(List<String> tokens,
 int startToken)
                                          throws JavaParsingException

Parses a single-line comment from the given tokens and starting index

Parameters:

tokens - The List of tokens to be parsed

startToken - The index of the token to start parsing at

Returns:

A ParsingPojo containing where we stopped parsing and the comment

Throws:

JavaParsingException - If anything goes wrong during parsing