javax.faces.component.TransientStateHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.3_spec Show documentation

JSR-000372: JavaServer(TM) Faces 2.3 API

There is a newer version: 3.1.0.SP02

Show newest version

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.faces.component;

/**
 * Define a Map-like contract
 * that makes it easier for components to implement {@link
 * TransientStateHolder}.  Each {@link UIComponent} in the view will
 * return an implementation of this interface from its {@link
 * UIComponent#getTransientStateHelper} method.
 * 
 * 
 * 
 * The values retrieved or saved through {@link
 * #getTransient} or {@link
 * #putTransient} will not be
 * preserved between requests.
 * 
 * 
 * 
 * @since 2.1
 * 
 */
public interface TransientStateHelper extends TransientStateHolder
{
    /**
     * Return the value currently
     * associated with the specified key if any.
     * @param key the key for which the value should be returned.
     * @return the stored value.
     * @since 2.1
     */
    public Object getTransient(Object key);
    
    /**
     * Performs the same logic as {@link
     * #getTransient} } but if no value is found, this
     * will return the specified defaultValue

     * @param key the key for which the value should be returned.
     * @param defaultValue the value to return if no value is found in
     * the call to get().
     * @return the stored value.
     * @since 2.1
     */
    public Object getTransient(Object key, Object defaultValue);

    /**
     * Return the previously stored value
     * and store the specified key/value pair.  This is intended to
     * store data that would otherwise reside in an instance variable on
     * the component.
     * 
     * @param key the key for the value
     * @param value the value
     * @return the previously stored value
     * @since 2.1
     */
    public Object putTransient(Object key, Object value);
}