io.vertigo.commons.parser.Parser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertigo-commons-api Show documentation

There is a newer version: 2.1.0

/**
 * vertigo - simple java starter
 *
 * Copyright (C) 2013, KleeGroup, [email protected] (http://www.kleegroup.com)
 * KleeGroup, Centre d'affaire la Boursidiere - BP 159 - 92357 Le Plessis Robinson Cedex - France
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.vertigo.commons.parser;

/**
 * Parser produces an object  or throw an exception.
 * A parser analyzes a text, according some rules.
 * A parser is responsible for moving the index position or throw an exception. 
 *
 * @author pchretien
 * @param Type of the product text parsing
 */
public interface Parser {
	/**
	 * Return the new index position.
	 * @param text Text to parse
	 * @param start Start of the element of text to parse
	 * @throws NotFoundException if parsing has failed.
	 * @return new index position
	 */
	int parse(String text, int start) throws NotFoundException;

	/**
	 * @return Product text parsing 
	 */
	R get();
}