com.stevewedig.blog.symbol

Interface SymbolMap

All Superinterfaces:

HasObjectHelper, Iterable<Map.Entry<Symbol<?>,Object>>

All Known Subinterfaces:

SymbolMap.Fluid, SymbolMap.Solid

public interface SymbolMap
extends Iterable<Map.Entry<Symbol<?>,Object>>, HasObjectHelper

A type safe mapping from symbols to values of matching types.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SymbolMap.Fluid A SymbolMap that is mutable and an entity object.
static interface	SymbolMap.Solid A SymbolMap that is immutable and a value object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Symbol<?> symbol) Is the symbol a key in the SymbolMap?
SymbolMap.Fluid	fluid() Get a SymbolMap.Fluid copy.
<Value> Value	get(Symbol<Value> symbol) Get the value associated with a symbol.
<Value> Value	getDefault(Symbol<Value> symbol, Value defaultValue) Get the value associated with a symbol, or the defaultValue if it is missing, or the defaultValue if the value is null.
<Value> Value	getDefault(Symbol<Value> symbol, Value defaultValue, boolean adaptNull) Get the value associated with a symbol, or the defaultValue if it is missing, or the defaultValue if its null and adaptNull = true.
<Value> Value	getNullable(Symbol<Value> symbol) Get the value associated with a symbol, or null if it is missing.
<Value> com.google.common.base.Optional<Value>	getOptional(Symbol<Value> symbol) Get the value associated with a symbol, or Optional.absent if it is missing, or Optional.absent if the value is null.
<Value> com.google.common.base.Optional<Value>	getOptional(Symbol<Value> symbol, boolean adaptNull) Get the value associated with a symbol, or Optional.absent if it is missing, or Optional.absent if the value is null and adaptTrue = true.
SymbolMap.Solid	solid() Get a SymbolMap.Solid copy.
Map<Symbol<?>,Object>	stateCopy() Get a Map copy of the state.
com.google.common.collect.ImmutableSet<Symbol<?>>	symbols() The set of contained symbols.

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface com.stevewedig.blog.value_objects.HasObjectHelper

objectHelper

Method Detail

get

<Value> Value get(Symbol<Value> symbol)

Get the value associated with a symbol.

getDefault

<Value> Value getDefault(Symbol<Value> symbol,
                       Value defaultValue)

Get the value associated with a symbol, or the defaultValue if it is missing, or the defaultValue if the value is null.

getDefault

<Value> Value getDefault(Symbol<Value> symbol,
                       Value defaultValue,
                       boolean adaptNull)

Get the value associated with a symbol, or the defaultValue if it is missing, or the defaultValue if its null and adaptNull = true.

getOptional

<Value> com.google.common.base.Optional<Value> getOptional(Symbol<Value> symbol)

Get the value associated with a symbol, or Optional.absent if it is missing, or Optional.absent if the value is null.

getOptional

<Value> com.google.common.base.Optional<Value> getOptional(Symbol<Value> symbol,
                                                         boolean adaptNull)

Get the value associated with a symbol, or Optional.absent if it is missing, or Optional.absent if the value is null and adaptTrue = true.

getNullable

<Value> Value getNullable(Symbol<Value> symbol)

Get the value associated with a symbol, or null if it is missing.

contains

boolean contains(Symbol<?> symbol)

Is the symbol a key in the SymbolMap?

symbols

com.google.common.collect.ImmutableSet<Symbol<?>> symbols()

The set of contained symbols.

fluid

SymbolMap.Fluid fluid()

Get a SymbolMap.Fluid copy.

solid

SymbolMap.Solid solid()

Get a SymbolMap.Solid copy.

stateCopy

Map<Symbol<?>,Object> stateCopy()

Get a Map copy of the state.