org.cthul.strings.format.ConversionPattern 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;

import java.util.Locale;
import java.util.regex.Matcher;

/**
 * Converts a format pattern into a regular expression.
 * 
 * @author Arian Treffer
 */
public interface ConversionPattern {
    
    /**
     * Appends pattern to regex
     * 
     * @param pattern
     * @param locale
     * @param flags
     * @param width
     * @param precision
     * @param formatString
     * @param position
     * @return additional characters that were read from {@code formatString},
     *         should be zero for most implementations.
     */
    int toRegex(PatternAPI pattern, Locale locale, String flags, int width, int precision, String formatString, int position);

    /**
     * Parses a pattern match.
     * 
     * @param matcherAPI
     * @param matcher
     * @param capturingBase
     * @param memento
     * @param lastArgValue
     * @return the parsed value
     */
    Object parse(MatcherAPI matcherAPI, Matcher matcher, int capturingBase, Object memento, Object lastArgValue);
    
    static interface Intermediate {
        
        Object complete();
        
    }
}