org.kefirsf.bb.conf.Variable Maven / Gradle / Ivy

Go to download

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

KefirBB is a Java-library for text processing. Initially it was developed for BB2HTML translation. But flexible configuration allows to use it in different cases. For example for parsing Markdown, Textile, and for HTML filtration.

The newest version!

package org.kefirsf.bb.conf;

import java.util.regex.Pattern;

/**
 * Variable pattern element.
 *
 * @author Vitaliy Samolovskih aka Kefir
 */
public class Variable extends GhostableNamedElement {
    public static final String DEFAULT_NAME = "variable";
    private java.util.regex.Pattern regex;
    private Action action = Action.rewrite;

    public Variable() {
        super();
        this.regex = null;
    }

    public Variable(String name) {
        super(name);
        this.regex = null;
    }

    public Variable(String name, java.util.regex.Pattern regex) {
        super(name);
        this.regex = regex;
    }

    /**
     * Get regular expression for validate variable.
     *
     * @return Regex pattern.
     */
    public java.util.regex.Pattern getRegex() {
        return regex;
    }

    /**
     * Set a regex pattern for validate variable.
     *
     * @param regex pattern
     */
    public void setRegex(Pattern regex) {
        this.regex = regex;
    }

    /**
     * Get the action of the variable.
     *
     * rewrite - rewrite current value
     * append - append a string to current value
     * check - check that current value is equals the variable value
     *
     * @return action
     */
    public Action getAction() {
        return action;
    }

    /**
     * Set the action of the variable.
     *
     * rewrite - rewrite current value
     * append - append a string to current value
     * check - check that current value is equals the variable value
     *
     * @param action action
     */
    public void setAction(Action action) {
        this.action = action;
    }
}