zserio.ast.DocComment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zserio Show documentation

Zserio Serialization Framework Compiler

The newest version!

package zserio.ast;

/**
 * Base class representing a single documentation comment.
 */
public abstract class DocComment extends AstNodeBase
{
    /**
     * Constructor.
     *
     * @param location AST node location.
     * @param isSticky True if the documentation comment is not followed by blank line.
     * @param isOneLiner True if the documentation comment is on one line in the source.
     */
    public DocComment(AstLocation location, boolean isSticky, boolean isOneLiner)
    {
        super(location);

        this.isSticky = isSticky;
        this.isOneLiner = isOneLiner;
    }

    /**
     * Checks if the documentation comment is sticky.
     *
     * @return True if the documentation comment is not followed by blank line.
     */
    public boolean isSticky()
    {
        return isSticky;
    }

    /**
     * Checks if the documentation comment is one-liner.
     *
     * @return True if the documentation comment is on one line in the source.
     */
    public boolean isOneLiner()
    {
        return isOneLiner;
    }

    /**
     * Finds the documentation comment of the given parameter in this documentation comment.
     *
     * @param paramName Name of the parameter to find.
     *
     * @return Extracted documentation comment for the given parameter or null if such comment does not exist.
     */
    public abstract DocComment findParamDoc(String paramName);

    /**
     * Converts the documentation comment to the classic documentation comment.
     *
     * @return Converted classic documentation comment.
     */
    public abstract DocCommentClassic toClassic();

    private final boolean isSticky;
    private final boolean isOneLiner;
}