phaselistenerdefinition.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.xml;

import javax.faces.event.PhaseListener;

/**
 * A <strong>PhaseListenerDefinition</strong> encapsulates and describes a
 * {@link PhaseListener} instance. Description (e.g. lifecycle-id) is needed for
 * registration purposes.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public final class PhaseListenerDefinition {

    /** The lifecycle id. */
    private final String lifecycleId;

    /** The encapsulated {@link PhaseListener}. */
    private final PhaseListener phaseListener;

    /**
     * Creates a definition with the given {@link PhaseListener}
     * <code>phaseListener</code> and the lifecycle id.
     * 
     * @param lifecycleId
     *            the lifecycle id
     * @param phaseListener
     *            the {@link PhaseListener}
     */
    public PhaseListenerDefinition(final String lifecycleId,
            final PhaseListener phaseListener) {
        super();
        this.lifecycleId = lifecycleId;
        this.phaseListener = phaseListener;
    }

    /**
     * @return the id of the {@link javax.faces.lifecycle.Lifecycle} the
     *         encapsulated {@link PhaseListener} will be registered for
     */
    public String getLifecycleId() {
        return lifecycleId;
    }

    /**
     * @return the encapsulated {@link PhaseListener}
     */
    public PhaseListener getPhaseListener() {
        return phaseListener;
    }

}