org.microbean.helm.chart

Class AbstractChartWriter.Context

java.lang.Object

org.microbean.helm.chart.AbstractChartWriter.Context

Enclosing class:

AbstractChartWriter

protected abstract static class AbstractChartWriter.Context
extends Object

A class representing the state of a write operation.

Author:

Laird Nelson

Method Summary

Modifier and Type	Method and Description
abstract boolean	containsKey(Object key) Returns true if this AbstractChartWriter.Context implementation contains an object indexed under an Object equal to the supplied key.
abstract <T> T	get(Object key, Class<T> type) Returns the object indexed under the supplied key, if any, cast to the proper Class.
abstract void	put(Object key, Object value) Stores the supplied value under the supplied key.
abstract void	remove(Object key) Removes any object indexed under an Object equal to the supplied key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public abstract <T> T get(Object key,
                          Class<T> type)

Returns the object indexed under the supplied key, if any, cast to the proper Class.

Implementations of this method may return null.

Type Parameters:

T - the type of object expected

Parameters:

key - the key under which something is hopefully stored; may be null

type - the Class to cast the result to; must not be null

Returns:

the object in question, or null

Throws:

NullPointerException - if type is null

See Also:

put(Object, Object)

put

public abstract void put(Object key,
                         Object value)

Stores the supplied value under the supplied key.

Parameters:

key - the key under which the supplied value will be stored; may be null

value - the object to store; may be null

See Also:

get(Object, Class)

containsKey

public abstract boolean containsKey(Object key)

Returns true if this AbstractChartWriter.Context implementation contains an object indexed under an Object equal to the supplied key.

Parameters:

key - the key in question; may be null

Returns:

true if this AbstractChartWriter.Context implementation contains an object indexed under an Object equal to the supplied key; false otherwise

remove

public abstract void remove(Object key)

Removes any object indexed under an Object equal to the supplied key.

Parameters:

key - the key in question; may be null