com.github.fge.uritemplate.parse.TemplateParser Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013, Francis Galiegue 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Lesser GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * Lesser GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package com.github.fge.uritemplate.parse;

import com.github.fge.uritemplate.URITemplateParseException;
import com.github.fge.uritemplate.expression.URITemplateExpression;

import java.nio.CharBuffer;

/*
 * Note: in spite of its name, this also parses literals
 */
interface TemplateParser
{
    /*
     * Rules:
     *
     * * the char buffer will always be positioned at the start of the current
     *   expression;
     * * the parser must swallow all characters until the end of the current
     *   expression.
     */
    URITemplateExpression parse(final CharBuffer buffer)
        throws URITemplateParseException;
}