org.asciidoctor.ast.StructuralNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asciidoctorj-api Show documentation
API for AsciidoctorJ
There is a newer version: 3.0.0
package org.asciidoctor.ast;

import java.util.List;
import java.util.Map;

public interface StructuralNode extends ContentNode {

    /**
     * Constant for special character replacement substitution like {@code <} to {@code &lt;}.
     * @see Special Character Substitutions
     */
    String SUBSTITUTION_SPECIAL_CHARACTERS = "specialcharacters";

    /**
     * Constant for quote replacements like {@code *bold*} to {@code bold}.
     * @see Quotes Substitutions
     */
    String SUBSTITUTION_QUOTES             = "quotes";

    /**
     * Constant for attribute replacements like {@code {foo}}.
     * @see Attribute References Substitution
     */
    String SUBSTITUTION_ATTRIBUTES         = "attributes";

    /**
     * Constant for replacements like {@code (C)} to {@code ©}.
     * @see Character Replacement Substitutions
     */
    String SUBSTITUTION_REPLACEMENTS       = "replacements";

    /**
     * Constant for macro replacements like {@code mymacro:target[]}.
     * @see Macro Substitutions
     */
    String SUBSTITUTION_MACROS             = "macros";

    /**
     * Constant for post replacements like creating line breaks from a trailing {@code +} in a line.
     * @see Post Replacement Substitutions
     */
    String SUBSTITUTION_POST_REPLACEMENTS  = "post_replacements";

    /**
     * @deprecated Please use {@linkplain #getTitle()} instead
     */
    @Deprecated
    String title();
    String getTitle();
    void setTitle(String title);

    String getCaption();
    void setCaption(String caption);

    /**
     * @deprecated Please use {@linkplain #getStyle()} instead
     */
    @Deprecated
    String style();
    String getStyle();

    void setStyle(String style);

    /**
     * @return The list of child blocks of this block
     * @deprecated Please use {@linkplain #getBlocks()} instead
     */
    @Deprecated
    List blocks();

    /**
     * @return The list of child blocks of this block
     */
    List getBlocks();

    /**
     * Appends a new child block as the last block to this block.
     * @param block The new child block added as last child to this block.
     */
    void append(StructuralNode block);

    /**
     * @deprecated Please use {@linkplain #getContent()} instead
     */
    @Deprecated
    Object content();
    Object getContent();
    String convert();
    List findBy(Map selector);

    int getLevel();

    void setLevel(int level);

    /**
     * Returns the content model.
     *
     * @see ContentModel
     *
     * @return the content model
     */
    String getContentModel();

    /**
     * Returns the source location of this block.
     * This information is only available if the {@code sourcemap} option is enabled when loading or rendering the document.
     * @return the source location of this block or {@code null} if the {@code sourcemap} option is not enabled when loading the document.
     */
    Cursor getSourceLocation();

    /**
     * Returns the list of enabled substitutions.
     * @return A list of substitutions enabled for this node, e.g. ["specialcharacters", "quotes", "attributes", "replacements", "macros", "post_replacements"] for paragraphs.
     * @see Asciidoctor User Manual
     */
    List getSubstitutions();

    /**
     * @param substitution the name of a substitution, e.g. {@link #SUBSTITUTION_POST_REPLACEMENTS}
     * @return true if the name of the given substitution is enabled.
     * @see Asciidoctor User Manual
     */
    boolean isSubstitutionEnabled(String substitution);

    /**
     * Removes the given substitution from this node.
     * @param substitution the name of a substitution, e.g. {@link #SUBSTITUTION_QUOTES}
     * @see Substitutions
     */
    void removeSubstitution(String substitution);

    /**
     * Adds the given substitution to this node at the end of the substitution list.
     * @param substitution the name of a substitution, e.g. {@link #SUBSTITUTION_MACROS}
     * @see Substitutions
     */
    void addSubstitution(String substitution);

    /**
     * Adds the given substitution to this node at the beginning of the substitution list.
     * @param substitution the name of a substitution, e.g. {@link #SUBSTITUTION_ATTRIBUTES}
     * @see Substitutions
     */
    void prependSubstitution(String substitution);

    /**
     * Sets the given substitutions on this node overwriting all other substitutions.
     * @param substitution the name of a substitution, e.g. {@link #SUBSTITUTION_SPECIAL_CHARACTERS}
     * @see Substitutions
     */
    void setSubstitutions(String... substitution);

}