org.xs4j.XMLNode Maven / Gradle / Ivy

Go to download

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

An attempt to port parsing capabilities offered by Groovy XMLSlurper into the Java world. The following is not planned to be accurate projection, instead the most useful functions will be implemented.

The newest version!

package org.xs4j;

import org.xs4j.util.NotNull;
import org.xs4j.util.Nullable;

import java.util.Map;

/**
 * A data structure holding information about a XML element.
 *
 * @author Marek Turski
 */
public interface XMLNode {
    /**
     *
     * @return id unique to the scope of one parsing execution
     */
    long getId();

    long getPosition();

    void setPosition(long position);

    int getDepth();

    void setDepth(int depth);

    @Nullable
    XMLNode getParent();

    void setParent(@Nullable XMLNode node);

    @Nullable
    String getNamespace();

    void setNamespace(@Nullable String namespace);

    @Nullable
    String getPrefix();

    void setPrefix(@Nullable String prefix);

    @NotNull
    String getLocalName();

    void setLocalName(@NotNull String name);

    @NotNull
    String getQName();

    @Nullable
    String getText();

    void setText(@Nullable String text);

    @Nullable
    String getAppendedText();

    void appendText(@Nullable String text);

    void appendText(@NotNull char[] text, int startPosition, int length);

    @NotNull
    Map getAttributes();

    void setAttributes(@NotNull Map attributeByQName);

    boolean hasAttribute(@NotNull String name);

    @Nullable
    String getAttribute(@Nullable String name);

    void setAttribute(@NotNull String name, @NotNull String value);
}