/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.component;
import java.io.Serializable;
/**
* <p class="changed_added_2_0">Define a <code>Map</code>-like contract
* that makes it easier for components to implement {@link
* PartialStateHolder}. Each {@link UIComponent} in the view will
* return an implementation of this interface from its {@link
* UIComponent#getStateHelper} method.</p>
*
* @since 2.0
*/
public interface StateHelper extends StateHolder {
/**
* <p class="changed_added_2_0">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.</p>
*
* @param key the key for the value
* @param value the value
* @return the previously stored value
* @since 2.0
*/
Object put(Serializable key, Object value);
/**
* <p class="changed_added_2_0">Remove the key/value pair from the
* helper, returning the value previously stored under this key.</p>
*
* @param key the key to remove
* @return the removed value.
* @since 2.0
*/
Object remove(Serializable key);
/**
* <p class="changed_added_2_0">Store the specified
* <code>mapKey</code>/<code>value</code> in a <code>Map</code> that
* is internal to the helper, and return the previously stored
* value. The <code>Map</code> will then be associated with
* <code>key</code>.</p>
*
* <div class="changed_added_2_0">
* <p>It's important to note for delta tracking that any
* modifications to the internal <code>Map</code> be made through
* this method or {@link StateHelper#remove(java.io.Serializable,
* Object)}.</p>
*
* </div>
*
* @param key the key of the map itself
* @param mapKey the key within the internal map
* @param value the value for the key in the internal map
* @return the value.
* @since 2.0
*/
Object put(Serializable key, String mapKey, Object value);
/**
* <p class="changed_added_2_0">Return the value currently
* associated with the specified <code>key</code> if any.</p>
*
* @param key the key for which the value should be returned.
* @return the value.
* @since 2.0
*/
Object get(Serializable key);
/**
* <p class="changed_added_2_0">Attempts to find a value associated
* with the specified key, using the value expression collection
* from the component if no such value is found.
*
* @param key the name of the value in the internal map, or the name
* of a value expression in the components value expression
* collection.</p>
* @return the evaluated value.
* @since 2.0
*/
Object eval(Serializable key);
/**
* <p class="changed_added_2_0">Performs the same logic as {@link
* #eval(java.io.Serializable)} } but if no value is found, this
* will return the specified <code>defaultValue</code></p>
* @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 <code>eval()</code>.
* @return the evaluated value.
* @since 2.0
*/
Object eval(Serializable key, Object defaultValue);
/**
* <p class="changed_added_2_0">Store the specified
* <code>value</code> in a <code>List</code> that is internal to the
* <code>StateHelper</code>.</p>
*
* <p class="changed_added_2_0">It's important to note for delta
* tracking that any modifications to the internal <code>List</code>
* be made through this method or {@link
* StateHelper#remove(java.io.Serializable, Object)}.</p>
*
* @param key the key for which the value should be returned.
* @param value the value to add
* @since 2.0
*/
void add(Serializable key, Object value);
/**
* <p class="changed_added_2_0">Remove a value from the inner data
* structure. Look in the inner data structure for the value at the
* given <code>key</code>. If the value is a <code>Map</code>,
* remove and return the value under the key given by the
* <code>valueOrKey</code> argument. If the value is a
* <code>Collection</code>, simply remove the value given by
* the argument <code>valueOrKey</code> and return null.</p>
*
* @param key the key of in the inner data structure whose value is
* a <code>Collection</code> or <code>Map</code>
* @param valueOrKey the value or key to be removed.
* @return the removed value.
*/
Object remove(Serializable key, Object valueOrKey);
}