< prev index next >
src/java.scripting/share/classes/javax/script/Bindings.java
Print this page
*** 26,36 ****
package javax.script;
import java.util.Map;
/**
* A mapping of key/value pairs, all of whose keys are
! * <code>Strings</code>.
*
* @author Mike Grogan
* @since 1.6
*/
public interface Bindings extends Map<String, Object> {
--- 26,36 ----
package javax.script;
import java.util.Map;
/**
* A mapping of key/value pairs, all of whose keys are
! * {@code Strings}.
*
* @author Mike Grogan
* @since 1.6
*/
public interface Bindings extends Map<String, Object> {
*** 47,122 ****
* @throws IllegalArgumentException if the name is empty String.
*/
public Object put(String name, Object value);
/**
! * Adds all the mappings in a given <code>Map</code> to this <code>Bindings</code>.
! * @param toMerge The <code>Map</code> to merge with this one.
*
* @throws NullPointerException
* if toMerge map is null or if some key in the map is null.
* @throws IllegalArgumentException
* if some key in the map is an empty String.
*/
public void putAll(Map<? extends String, ? extends Object> toMerge);
/**
! * Returns <tt>true</tt> if this map contains a mapping for the specified
! * key. More formally, returns <tt>true</tt> if and only if
! * this map contains a mapping for a key <tt>k</tt> such that
! * <tt>(key==null ? k==null : key.equals(k))</tt>. (There can be
* at most one such mapping.)
*
* @param key key whose presence in this map is to be tested.
! * @return <tt>true</tt> if this map contains a mapping for the specified
* key.
*
* @throws NullPointerException if key is null
* @throws ClassCastException if key is not String
* @throws IllegalArgumentException if key is empty String
*/
public boolean containsKey(Object key);
/**
* Returns the value to which this map maps the specified key. Returns
! * <tt>null</tt> if the map contains no mapping for this key. A return
! * value of <tt>null</tt> does not <i>necessarily</i> indicate that the
* map contains no mapping for the key; it's also possible that the map
! * explicitly maps the key to <tt>null</tt>. The <tt>containsKey</tt>
* operation may be used to distinguish these two cases.
*
* <p>More formally, if this map contains a mapping from a key
! * <tt>k</tt> to a value <tt>v</tt> such that <tt>(key==null ? k==null :
! * key.equals(k))</tt>, then this method returns <tt>v</tt>; otherwise
! * it returns <tt>null</tt>. (There can be at most one such mapping.)
*
* @param key key whose associated value is to be returned.
* @return the value to which this map maps the specified key, or
! * <tt>null</tt> if the map contains no mapping for this key.
*
* @throws NullPointerException if key is null
* @throws ClassCastException if key is not String
* @throws IllegalArgumentException if key is empty String
*/
public Object get(Object key);
/**
* Removes the mapping for this key from this map if it is present
* (optional operation). More formally, if this map contains a mapping
! * from key <tt>k</tt> to value <tt>v</tt> such that
! * <code>(key==null ? k==null : key.equals(k))</code>, that mapping
* is removed. (The map can contain at most one such mapping.)
*
* <p>Returns the value to which the map previously associated the key, or
! * <tt>null</tt> if the map contained no mapping for this key. (A
! * <tt>null</tt> return can also indicate that the map previously
! * associated <tt>null</tt> with the specified key if the implementation
! * supports <tt>null</tt> values.) The map will not contain a mapping for
* the specified key once the call returns.
*
* @param key key whose mapping is to be removed from the map.
! * @return previous value associated with specified key, or <tt>null</tt>
* if there was no mapping for key.
*
* @throws NullPointerException if key is null
* @throws ClassCastException if key is not String
* @throws IllegalArgumentException if key is empty String
--- 47,123 ----
* @throws IllegalArgumentException if the name is empty String.
*/
public Object put(String name, Object value);
/**
! * Adds all the mappings in a given {@code Map} to this {@code Bindings}.
! * @param toMerge The {@code Map} to merge with this one.
*
* @throws NullPointerException
* if toMerge map is null or if some key in the map is null.
* @throws IllegalArgumentException
* if some key in the map is an empty String.
*/
public void putAll(Map<? extends String, ? extends Object> toMerge);
/**
! * Returns {@code true} if this map contains a mapping for the specified
! * key. More formally, returns {@code true} if and only if
! * this map contains a mapping for a key {@code k} such that
! * {@code (key==null ? k==null : key.equals(k))}. (There can be
* at most one such mapping.)
*
* @param key key whose presence in this map is to be tested.
! * @return {@code true} if this map contains a mapping for the specified
* key.
*
* @throws NullPointerException if key is null
* @throws ClassCastException if key is not String
* @throws IllegalArgumentException if key is empty String
*/
public boolean containsKey(Object key);
/**
* Returns the value to which this map maps the specified key. Returns
! * {@code null} if the map contains no mapping for this key. A return
! * value of {@code null} does not <i>necessarily</i> indicate that the
* map contains no mapping for the key; it's also possible that the map
! * explicitly maps the key to {@code null}. The {@code containsKey}
* operation may be used to distinguish these two cases.
*
* <p>More formally, if this map contains a mapping from a key
! * {@code k} to a value {@code v} such that
! * {@code (key==null ? k==null : key.equals(k))},
! * then this method returns {@code v}; otherwise
! * it returns {@code null}. (There can be at most one such mapping.)
*
* @param key key whose associated value is to be returned.
* @return the value to which this map maps the specified key, or
! * {@code null} if the map contains no mapping for this key.
*
* @throws NullPointerException if key is null
* @throws ClassCastException if key is not String
* @throws IllegalArgumentException if key is empty String
*/
public Object get(Object key);
/**
* Removes the mapping for this key from this map if it is present
* (optional operation). More formally, if this map contains a mapping
! * from key {@code k} to value {@code v} such that
! * {@code (key==null ? k==null : key.equals(k))}, that mapping
* is removed. (The map can contain at most one such mapping.)
*
* <p>Returns the value to which the map previously associated the key, or
! * {@code null} if the map contained no mapping for this key. (A
! * {@code null} return can also indicate that the map previously
! * associated {@code null} with the specified key if the implementation
! * supports {@code null} values.) The map will not contain a mapping for
* the specified key once the call returns.
*
* @param key key whose mapping is to be removed from the map.
! * @return previous value associated with specified key, or {@code null}
* if there was no mapping for key.
*
* @throws NullPointerException if key is null
* @throws ClassCastException if key is not String
* @throws IllegalArgumentException if key is empty String
< prev index next >