validatorfactory.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * Copyright 2002-2004 the original author or authors.
 *
 * 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 de.mindmatters.faces.application;

import java.util.Iterator;

import javax.faces.application.Application;
import javax.faces.validator.Validator;

/**
 * <strong>Factory</strong> for managing {@link Validator}s. Used by
 * {@link ApplicationImpl}.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public interface ValidatorFactory {

    /**
     * Register a new mapping of validator id to the name of the corresponding
     * {@link Validator} class. This allows subsequent calls to
     * <code>createValidator()</code> to serve as a factory for
     * {@link Validator} instances.
     * 
     * @param application
     *            the <strong>original</strong> Application of the underlying
     *            JSF implementation
     * @param validatorId
     *            The validator id to be registered
     * @param validatorClass
     *            The fully qualified class name of the corresponding
     *            {@link Validator} implementation
     * 
     * @exception NullPointerException
     *                if <code>validatorId</code> or
     *                <code>validatorClass</code> is <code>null</code>
     */
    void addValidator(Application application, String validatorId,
            String validatorClass);

    /**
     * Instantiate and return a new {@link Validator} instance of the class
     * specified by a previous call to <code>addValidator()</code> for the
     * specified validator id.
     * 
     * @param application
     *            the <strong>original</strong> Application of the underlying
     *            JSF implementation
     * @param validatorId
     *            The validator id for which to create and return a new
     *            {@link Validator} instance
     * @return th created Validator
     * @exception javax.faces.FacesException
     *                if a {@link Validator} of the specified id cannot be
     *                created
     * @exception NullPointerException
     *                if <code>validatorId</code> is <code>null</code>
     */
    Validator createValidator(Application application, String validatorId);

    /**
     * Return an <code>Iterator</code> over the set of currently registered
     * validator ids for this <code>Application</code>.
     * 
     * @param application
     *            the <strong>original</strong> Application of the underlying
     *            JSF implementation
     * @return An Iterator over the set of currently registered validator ids
     */
    Iterator getValidatorIds(Application application);

}