constantmethodbinding.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.el;

import javax.faces.component.StateHolder;
import javax.faces.context.FacesContext;
import javax.faces.el.MethodBinding;

/**
 * Convenient method binding that does nothing other than returning a fixed
 * outcome String when invoked.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public final class ConstantMethodBinding extends MethodBinding implements
        StateHolder {

    /** The fixed outcome String. */
    private String action;

    /** The transient flag. */
    private boolean isTransient;

    /**
     * Default constructor.
     */
    public ConstantMethodBinding() {
    }

    /**
     * Creates an method binding that takes a fixed outcome string
     * <code>action</code>.
     * 
     * @param action
     *            The fixed outcome String
     */
    public ConstantMethodBinding(final String action) {
        this.action = action;
    }

    /**
     * {@inheritDoc}
     */
    public Class getType(final FacesContext context) {
        return String.class;
    }

    /**
     * {@inheritDoc}
     */
    public Object invoke(final FacesContext context, final Object[] params) {
        return this.action;
    }

    /**
     * {@inheritDoc}
     */
    public boolean isTransient() {
        return isTransient;
    }

    /**
     * {@inheritDoc}
     */
    public void setTransient(final boolean newTransientValue) {
        this.isTransient = newTransientValue;
    }

    /**
     * {@inheritDoc}
     */
    public Object saveState(final FacesContext context) {
        return this.action;
    }

    /**
     * {@inheritDoc}
     */
    public void restoreState(final FacesContext context, final Object state) {
        this.action = state.toString();
    }

}