net.java.textilej.parser.markup.PatternBasedElement Maven / Gradle / Ivy
package net.java.textilej.parser.markup;
/**
* An element of markup that is detected using a regular expression pattern.
* Serves as a means of detecting markup elements and providing a factory for processors that can
* process the markup element.
*
* Implementations of this class must be thread-safe (generally stateless).
*
* @author dgreen
*
* @param
*/
public abstract class PatternBasedElement {
/**
* Get the regular expression pattern that matches this element.
* Generally the pattern may be assembled into a single larger regular expression.
*
* @param groupOffset the offset of the groups in the pattern, 0 indicating no offset
*
* @return the regular expression pattern
*/
protected abstract String getPattern(int groupOffset);
/**
* The number of capturing groups in the {@link #getPattern(int) pattern}. Note that implementations must
* take care to return the correct value otherwise the dialect will not work correctly.
*/
protected abstract int getPatternGroupCount();
/**
* create a new processor for processing the type of element detected by this class.
*/
protected abstract PatternBasedElementProcessor newProcessor();
}