xapi.collect.api

Interface InitMap<Key,Value>

Type Parameters:

Key -

Value -

All Superinterfaces:

xapi.util.api.ConvertsValue<Key,Value>, xapi.collect.api.Dictionary<String,Value>, Iterable<Map.Entry<String,Value>>, xapi.collect.api.StringDictionary<Value>

All Known Implementing Classes:

AbstractInitMap, AbstractMultiInitMap, InitMapDefault, InitMapString, RuntimeInjectorAbstract.ScopeMap

public interface InitMap<Key,Value>
extends xapi.collect.api.StringDictionary<Value>, xapi.util.api.ConvertsValue<Key,Value>, Iterable<Map.Entry<String,Value>>

Our init map purposely forces string-key semantics, to force our subclasses to take care of key serialization for us. AbstractInitMap will accept a key converter, which will work, and allow reuse of code and singleton sharing, but will be slower than if you extends an existing StringDictionary

Author:

"James X. Nelson (james@wetheinter.net)"

Field Summary

Fields inherited from interface xapi.util.api.ConvertsValue

PASS_THRU

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Key key)
Value	get(Key key)
Value	initialize(Key key)
Value	put(Key key, Value value)
String	toKey(Key key) We force subclasses to deal with serializing keys to unique names, so javascript can implement this directly on an object, and you can achieve a degree of portability, by making map structure deterministic.

Methods inherited from interface xapi.collect.api.Dictionary

clearValues, forKeys, getValue, hasKey, removeValue, setValue

Methods inherited from interface xapi.util.api.ConvertsValue

convert

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

initialize

Value initialize(Key key)

Parameters:

key - - The Key used when value was null.

Returns:

- A newly created instance of whatever you need to init. Note that you can use Pair<,> or Triple<,,> to overload your key type.

toKey

String toKey(Key key)

We force subclasses to deal with serializing keys to unique names, so javascript can implement this directly on an object, and you can achieve a degree of portability, by making map structure deterministic.

Parameters:

key - - A key of whatever type you want. Use Pair or Triple to overload.

Returns:

- A unique key for dictionary-like sematics try to have a string id pre-constructed; if your object fields are immutable, you can safely construct the id, and never have to null check.

get

Value get(Key key)

containsKey

boolean containsKey(Key key)

put

Value put(Key key,
          Value value)