Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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.dev.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;
 

Define a Map-like contract that makes it easier for components to implement PartialStateHolder. Each UIComponent in the view will return an implementation of this interface from its UIComponent.getStateHelper() method.

Since:
2.0
 
 public interface StateHelper extends StateHolder {


    

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.

Parameters:
key the key for the value
value the value
Since:
2.0
 
     Object put(Serializable keyObject value);


    

Remove the key/value pair from the helper, returning the value previously stored under this key.

Parameters:
key the key to remove
Since:
2.0
 
     Object remove(Serializable key);


    

Store the specified mapKey/value in a Map that is internal to the helper, and return the previously stored value. The Map will then be associated with key.

It's important to note for delta tracking that any modifications to the internal Map be made through this method or remove(java.io.Serializable,java.lang.Object).

Parameters:
key the key of the map itself
mapKey the key within the internal map
value the value for the key in the internal map
Since:
2.0
    Object put(Serializable keyString mapKeyObject value);


    

Return the value currently associated with the specified key if any.

Parameters:
key the key for which the value should be returned.
Since:
2.0
    Object get(Serializable key);


    

Attempts to find a value associated with the specified key, using the value expression collection from the component if no such value is found.

Parameters:
key the name of the value in the internal map, or the name of a value expression in the components value expression collection.
Since:
2.0
    Object eval(Serializable key);


    

Performs the same logic as eval(java.io.Serializable) } but if no value is found, this will return the specified defaultValue

Parameters:
key the key for which the value should be returned.
defaultValue the value to return if no value is found in the call to eval().
Since:
2.0
    Object eval(Serializable keyObject defaultValue);


    

Store the specified value in a List that is internal to the StateHelper.

It's important to note for delta tracking that any modifications to the internal List be made through this method or remove(java.io.Serializable,java.lang.Object).

Parameters:
key the key for which the value should be returned.
value the value to add
Since:
2.0
    void add(Serializable keyObject value);


    

Remove a value from the inner data structure. Look in the inner data structure for the value at the given key. If the value is a Map, remove and return the value under the key given by the valueOrKey argument. If the value is a Collection, simply remove the value given by the argument valueOrKey and return null.

Parameters:
key the key of in the inner data structure whose value is a Collection or Map
valueOrKey the value or key to be removed.
    Object remove(Serializable keyObject valueOrKey);
New to GrepCode? Check out our FAQ X