org.cthul.strings.format.PatternAPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cthul-strings Show documentation

Functions for converting strings from and to various formats, such as roman numbers, alpha indices, Java identifiers, and format strings.

The newest version!

package org.cthul.strings.format;

/**
 * Used by {@link ConversionPattern}s to generate a regular expression.
 * @author Arian Treffer
 */
public interface PatternAPI extends Appendable {
    
    @Override
    PatternAPI append(char c);
    
    @Override
    PatternAPI append(CharSequence csq);
    
    @Override
    PatternAPI append(CharSequence csq, int start, int end);
    
    /**
     * To be called when a capturing group was added.
     */
    PatternAPI addedCapturingGroup();
    
    /**
     * To be called when capturing groups were added.
     * @param i number of capturing groups
     */
    PatternAPI addedCapturingGroups(int i);
    
    /**
     * Stores a value the will be provided for parsing the match.
     * 
     * @param newMemento
     * @return last value
     */
    Object putMemento(Object newMemento);
    
    PatternData parse(PatternAPI api, String format);
    
    PatternData parse(PatternAPI api, String format, int start, int end);
    
}