Bindings (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.script
interface Bindings

All Superinterfaces:: Map

All Known Implementing Classes:: SimpleBindings

Most common ways to construct:

Bindings bindings = new SimpleBindings();

Based on 12 examples

ScriptEngine engine = …;

Bindings bindings = engine.createBindings();

Based on 11 examples

public interface Bindings
extends Map

A mapping of key/value pairs, all of whose keys are Strings.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.Map
`Map.Entry`

Method Summary
`boolean`	`containsKey(Object key)` Returns `true` if this map contains a mapping for the specified key.
`Object`	`get(Object key)` Returns the value to which this map maps the specified key.
`Object`	`put(String name, Object value)` Set a named value.
`void`	`putAll(Map toMerge)` Adds all the mappings in a given `Map` to this `Bindings`.
`Object`	`remove(Object key)` Removes the mapping for this key from this map if it is present (optional operation).

Methods inherited from class java.util.Map
`clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values`

Method Detail

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Parameters:: key - key whose presence in this map is to be tested.
Returns:: true if this map contains a mapping for the specified key.

get

public Object get(Object key)

Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

Parameters:: key - key whose associated value is to be returned.
Returns:: the value to which this map maps the specified key, or null if the map contains no mapping for this key.

put

public Object put(String name,
                  Object value)

Set a named value.

Parameters:: name - The name associated with the value.; value - The value associated with the name.
Returns:: The value previously associated with the given name. Returns null if no value was previously associated with the name.

putAll

public void putAll(Map toMerge)

Adds all the mappings in a given Map to this Bindings.

Parameters:: toMerge - The Map to merge with this one.

remove

public Object remove(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 k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.

Parameters:: key - key whose mapping is to be removed from the map.
Returns:: previous value associated with specified key, or null if there was no mapping for key.