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

Go to download
/*
 * Copyright (c) 2014, Francis Galiegue ([email protected])
 *
 * This software is dual-licensed under:
 *
 * - the Lesser General Public License (LGPL) version 3.0 or, at your option, any
 *   later version;
 * - the Apache Software License (ASL) version 2.0.
 *
 * The text of both licenses is available under the src/resources/ directory of
 * this project (under the names LGPL-3.0.txt and ASL-2.0.txt respectively).
 *
 * Direct link to the sources:
 *
 * - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
 * - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
 */

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;
}