io.vertigo.commons.parser.ManyRule 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-2016, 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;

import java.util.List;

import io.vertigo.lang.Assertion;

/**
 * The manyRule.
 * If the pattern AB is searched and 
 * the text is 
 *  - empty : an empty list is returned only if emptyAccepted.
 *  - ABAB : a list with a size of 2 is returned 
 *  - ABABC : a list with a size of 2 is returned only if repeat is false.
 *  
 *  if repeat is true then all the text must be consumed during the evaluation.	
 *   
 * @author pchretien
 * @param  Type of the product text parsing
 */
public final class ManyRule implements Rule> {
	private final Rule rule;
	private final boolean emptyAccepted;

	private final boolean repeat;

	/**
	 * Constructor.
	 * @param rule the rule that's will be evaluated
	 * @param emptyAccepted If an empty list is accepted
	 * @param repeat if the evaluation must be repeated  
	 */
	public ManyRule(final Rule rule, final boolean emptyAccepted, final boolean repeat) {
		Assertion.checkNotNull(rule);
		//-----
		this.rule = rule;
		this.emptyAccepted = emptyAccepted;
		this.repeat = repeat;
	}

	/**
	 * Constructor.
	 * @param rule the rule that's will be evaluated
	 * @param emptyAccepted If an empty list is accepted
	 */
	public ManyRule(final Rule rule, final boolean emptyAccepted) {
		this(rule, emptyAccepted, false);
	}

	/** {@inheritDoc} */
	@Override
	public String getExpression() {
		return "(" + rule.getExpression() + ")" + (emptyAccepted ? "*" : "+");
	}

	boolean isEmptyAccepted() {
		return emptyAccepted;
	}

	boolean isRepeat() {
		return repeat;
	}

	Rule getRule() {
		return rule;
	}

	/** {@inheritDoc} */
	@Override
	public Parser> createParser() {
		return new ManyRuleParser<>(this);
	}
}