Java JavadocTokenTypes.TEXT属性代码示例

/**
 * Determines whether or not the line with paragraph tag is first line in javadoc.
 * @param paragraphTag paragraph tag.
 * @return true, if line with paragraph tag is first line in javadoc.
 */
private static boolean isFirstParagraph(DetailNode paragraphTag) {
    boolean result = true;
    DetailNode previousNode = JavadocUtils.getPreviousSibling(paragraphTag);
    while (previousNode != null) {
        if (previousNode.getType() == JavadocTokenTypes.TEXT
                && !CommonUtils.isBlank(previousNode.getText())
            || previousNode.getType() != JavadocTokenTypes.LEADING_ASTERISK
                && previousNode.getType() != JavadocTokenTypes.NEWLINE
                && previousNode.getType() != JavadocTokenTypes.TEXT) {
            result = false;
            break;
        }
        previousNode = JavadocUtils.getPreviousSibling(previousNode);
    }
    return result;
}
 

@Override
public void visitJavadocToken(DetailNode ast) {
    if (!isInlineDescription(ast)) {
        final List<DetailNode> textNodes = getAllNewlineNodes(ast);
        for (DetailNode newlineNode : textNodes) {
            final DetailNode textNode = JavadocUtils.getNextSibling(JavadocUtils
                    .getNextSibling(newlineNode));
            if (textNode != null && textNode.getType() == JavadocTokenTypes.TEXT) {
                final String text = textNode.getText();
                if (!CommonUtils.isBlank(text.trim())
                        && (text.length() <= offset
                                || !text.substring(1, offset + 1).trim().isEmpty())) {
                    log(textNode.getLineNumber(), MSG_KEY, offset);
                }
            }
        }
    }
}
 

public static void printTree(DetailNode aRoot)
{

    if (aRoot.getChildren().length != 0) {
        for (DetailNode node : aRoot.getChildren()) {
            System.out.println(getLevel(node) + node.toString()
                    + " : ["
                    + node.getText().replaceAll("\n", "\\\\n").replaceAll("\r", "\\\\r")
                    .replaceAll("\t", "\\\\t")
                    + "]");

            if (node.getType() == JavadocTokenTypes.TEXT) {
                continue;
            }

            printTree(node);
        }
    }
}
 

/**
 * Concatenates string within text of html tags.
 * @param result javadoc string
 * @param detailNode javadoc tag node
 * @return java doc tag content appended in result
 */
private static String getStringInsideTag(String result, DetailNode detailNode) {
    final StringBuilder contents = new StringBuilder(result);
    DetailNode tempNode = detailNode;
    while (tempNode != null) {
        if (tempNode.getType() == JavadocTokenTypes.TEXT) {
            contents.append(tempNode.getText());
        }
        tempNode = JavadocUtils.getNextSibling(tempNode);
    }
    return contents.toString();
}
 

/**
 * Determines whether or not the next line after empty line has paragraph tag in the beginning.
 * @param newline NEWLINE node.
 */
private void checkEmptyLine(DetailNode newline) {
    final DetailNode nearestToken = getNearestNode(newline);
    if (!isLastEmptyLine(newline) && nearestToken.getType() == JavadocTokenTypes.TEXT
            && !CommonUtils.isBlank(nearestToken.getText())) {
        log(newline.getLineNumber(), MSG_TAG_AFTER);
    }
}
 

/**
 * Determines whether or not the line is empty line.
 * @param newLine NEWLINE node.
 * @return true, if line is empty line.
 */
private static boolean isEmptyLine(DetailNode newLine) {
    boolean result = false;
    DetailNode previousSibling = JavadocUtils.getPreviousSibling(newLine);
    if (previousSibling != null
            && previousSibling.getParent().getType() == JavadocTokenTypes.JAVADOC) {
        if (previousSibling.getType() == JavadocTokenTypes.TEXT
                && CommonUtils.isBlank(previousSibling.getText())) {
            previousSibling = JavadocUtils.getPreviousSibling(previousSibling);
        }
        result = previousSibling != null
                && previousSibling.getType() == JavadocTokenTypes.LEADING_ASTERISK;
    }
    return result;
}
 

/**
 * Tests if NEWLINE node is a last node in javadoc.
 * @param newLine NEWLINE node.
 * @return true, if NEWLINE node is a last node in javadoc.
 */
private static boolean isLastEmptyLine(DetailNode newLine) {
    boolean result = true;
    DetailNode nextNode = JavadocUtils.getNextSibling(newLine);
    while (nextNode != null && nextNode.getType() != JavadocTokenTypes.JAVADOC_TAG) {
        if (nextNode.getType() == JavadocTokenTypes.TEXT
                && !CommonUtils.isBlank(nextNode.getText())
                || nextNode.getType() == JavadocTokenTypes.HTML_ELEMENT) {
            result = false;
            break;
        }
        nextNode = JavadocUtils.getNextSibling(nextNode);
    }
    return result;
}
 

/**
 * Converts ParseTree (that is generated by ANTLRv4) to DetailNode tree.
 *
 * @param parseTreeNode root node of ParseTree
 * @return root of DetailNode tree
 * @noinspection SuspiciousArrayCast
 */
private DetailNode convertParseTreeToDetailNode(ParseTree parseTreeNode) {
    final JavadocNodeImpl rootJavadocNode = createRootJavadocNode(parseTreeNode);

    JavadocNodeImpl currentJavadocParent = rootJavadocNode;
    ParseTree parseTreeParent = parseTreeNode;

    while (currentJavadocParent != null) {
        // remove unnecessary children tokens
        if (currentJavadocParent.getType() == JavadocTokenTypes.TEXT) {
            currentJavadocParent
                    .setChildren((DetailNode[]) JavadocNodeImpl.EMPTY_DETAIL_NODE_ARRAY);
        }

        final JavadocNodeImpl[] children =
                (JavadocNodeImpl[]) currentJavadocParent.getChildren();

        insertChildrenNodes(children, parseTreeParent);

        if (children.length > 0) {
            currentJavadocParent = children[0];
            parseTreeParent = parseTreeParent.getChild(0);
        }
        else {
            JavadocNodeImpl nextJavadocSibling = (JavadocNodeImpl) JavadocUtils
                    .getNextSibling(currentJavadocParent);

            ParseTree nextParseTreeSibling = getNextSibling(parseTreeParent);

            if (nextJavadocSibling == null) {
                JavadocNodeImpl tempJavadocParent =
                        (JavadocNodeImpl) currentJavadocParent.getParent();

                ParseTree tempParseTreeParent = parseTreeParent.getParent();

                while (nextJavadocSibling == null && tempJavadocParent != null) {

                    nextJavadocSibling = (JavadocNodeImpl) JavadocUtils
                            .getNextSibling(tempJavadocParent);

                    nextParseTreeSibling = getNextSibling(tempParseTreeParent);

                    tempJavadocParent = (JavadocNodeImpl) tempJavadocParent.getParent();
                    tempParseTreeParent = tempParseTreeParent.getParent();
                }
            }
            currentJavadocParent = nextJavadocSibling;
            parseTreeParent = nextParseTreeSibling;
        }
    }

    return rootJavadocNode;
}
 

@Override
public int[] getRequiredJavadocTokens() {
    return new int[] {JavadocTokenTypes.TEXT};
}
 

/**
 * Converts ParseTree (that is generated by ANTLRv4) to DetailNode tree.
 *
 * @param parseTreeNode root node of ParseTree
 * @return root of DetailNode tree
 * @noinspection SuspiciousArrayCast
 */
private DetailNode convertParseTreeToDetailNode(ParseTree parseTreeNode) {
    final JavadocNodeImpl rootJavadocNode = createRootJavadocNode(parseTreeNode);

    JavadocNodeImpl currentJavadocParent = rootJavadocNode;
    ParseTree parseTreeParent = parseTreeNode;

    while (currentJavadocParent != null) {
        // remove unnecessary children tokens
        if (currentJavadocParent.getType() == JavadocTokenTypes.TEXT) {
            currentJavadocParent
                    .setChildren((DetailNode[]) JavadocNodeImpl.EMPTY_DETAIL_NODE_ARRAY);
        }

        final JavadocNodeImpl[] children =
                (JavadocNodeImpl[]) currentJavadocParent.getChildren();

        insertChildrenNodes(children, parseTreeParent);

        if (children.length > 0) {
            currentJavadocParent = children[0];
            parseTreeParent = parseTreeParent.getChild(0);
        }
        else {
            JavadocNodeImpl nextJavadocSibling = (JavadocNodeImpl) JavadocUtils
                    .getNextSibling(currentJavadocParent);

            ParseTree nextParseTreeSibling = getNextSibling(parseTreeParent);

            if (nextJavadocSibling == null) {
                JavadocNodeImpl tempJavadocParent =
                        (JavadocNodeImpl) currentJavadocParent.getParent();

                ParseTree tempParseTreeParent = parseTreeParent.getParent();

                while (nextJavadocSibling == null && tempJavadocParent != null) {
                    nextJavadocSibling = (JavadocNodeImpl) JavadocUtils
                            .getNextSibling(tempJavadocParent);

                    nextParseTreeSibling = getNextSibling(tempParseTreeParent);

                    tempJavadocParent = (JavadocNodeImpl) tempJavadocParent.getParent();
                    tempParseTreeParent = tempParseTreeParent.getParent();
                }
            }
            currentJavadocParent = nextJavadocSibling;
            parseTreeParent = nextParseTreeSibling;
        }
    }

    return rootJavadocNode;
}