converterdefinition.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.spring.factory.aspectj;

/**
 * A <strong>ConverterDefinition</strong> encapsulates and describes a
 * {@link javax.faces.convert.Converter} instance. Description (e.g. kind of
 * registration) is needed for registration purposes.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public final class ConverterDefinition {

    /** Classname and rgistrar. */
    private final String converterRegistrar, converterClassName;

    /** Register by id? */
    private final boolean registerById;

    /**
     * Creates a definition with the given descriptors.
     * 
     * @param converterRegistrar
     *            the registration key
     * @param converterClassName
     *            the class name of the converter
     * @param registerById
     *            <code>true</code> if the converter should be registered by
     *            id <code>false</code> if by class
     */
    public ConverterDefinition(final String converterRegistrar,
            final String converterClassName, final boolean registerById) {
        super();
        this.converterRegistrar = converterRegistrar;
        this.converterClassName = converterClassName;
        this.registerById = registerById;
    }

    /**
     * @return the registration key
     */
    public String getConverterRegistrar() {
        return converterRegistrar;
    }

    /**
     * @return the class name of the converter
     */
    public String getConverterClassName() {
        return converterClassName;
    }

    /**
     * @return <code>true</code> if the converter should be registered by id
     *         <code>false</code> if by class
     */
    public boolean registerById() {
        return this.registerById;
    }

}