# Rule.java

    /*******************************************************************************
     * Copyright (c) 2009, 2013 Mountainminds GmbH & Co. KG and Contributors
     * All rights reserved. This program and the accompanying materials
     * are made available under the terms of the Eclipse Public License v1.0
     * which accompanies this distribution, and is available at
     * http://www.eclipse.org/legal/epl-v10.html
     *
     * Contributors:
     *    Marc R. Hoffmann - initial API and implementation
     *
     *******************************************************************************/
    package org.jacoco.report.check;

    import java.util.ArrayList;
    import java.util.List;

    import org.jacoco.core.analysis.ICoverageNode.ElementType;
    import org.jacoco.core.runtime.WildcardMatcher;

    /**
     * A rule applies for a certain element type and can define any number of limits
     * for all elements of this type.
     */
    public final class Rule {

    	private ElementType element;
    	private String includes;
    	private String excludes;
    	private List<Limit> limits;

    	private WildcardMatcher includesMatcher;
    	private WildcardMatcher excludesMatcher;

    	/**
    	 * Creates a new Rule without limits.
    	 */
    	public Rule() {
    		this.element = ElementType.BUNDLE;
    		this.limits = new ArrayList<Limit>();
    		this.setIncludes("*");
    		this.setExcludes("");
    	}

    	/**
    	 * @return element type this rule applies to
    	 */
    	public ElementType getElement() {
    		return element;
    	}

    	/**
    	 * @param elementType
    	 *            element type this rule applies to
    	 */
    	public void setElement(final ElementType elementType) {
    		this.element = elementType;
    	}

    	/**
    	 * @return includes pattern
    	 */
    	public String getIncludes() {
    		return includes;
    	}

    	/**
    	 * @param includes
    	 *            includes pattern
    	 */
    	public void setIncludes(final String includes) {
    		this.includes = includes;
    		this.includesMatcher = new WildcardMatcher(includes);
    	}

    	/**
    	 * @return excludes pattern
    	 */
    	public String getExcludes() {
    		return excludes;
    	}

    	/**
    	 *
    	 * @param excludes
    	 *            excludes patterns
    	 */
    	public void setExcludes(final String excludes) {
    		this.excludes = excludes;
    		this.excludesMatcher = new WildcardMatcher(excludes);
    	}

    	/**
    	 * @return list of {@link Limit}s configured for this rule
    	 */
    	public List<Limit> getLimits() {
    		return limits;
    	}

    	/**
    	 * @param limits
    	 *            list of {@link Limit}s configured for this rule
    	 */
    	public void setLimits(final List<Limit> limits) {
    		this.limits = limits;
    	}

    	/**
    	 * Creates and adds a new {@link Limit}.
    	 *
    	 * @return creates {@link Limit}
    	 */
    	public Limit createLimit() {
    		final Limit limit = new Limit();
    		this.limits.add(limit);
    		return limit;
    	}

    	boolean matches(final String name) {
    		return includesMatcher.matches(name) && !excludesMatcher.matches(name);
    	}

    }