Module swim.structure

Package swim.structure.form

Class MapForm<K,V>

java.lang.Object

swim.structure.Form<Map<K,V>>

swim.structure.form.MapForm<K,V>

public final class MapForm<K,V>
extends Form<Map<K,V>>

For some Map<K,V>, a transformation between a structurally typed Item and an instance of that Map.

Constructor Summary

Constructors

Constructor	Description
MapForm(Class<?> type, Form<K> keyForm, Form<V> valForm)

Method Summary

Modifier and Type	Method	Description
Map<K,V>	cast(Item item)	Converts a structurally typed item into a nominally typed Java object.
Map<K,V>	cast(Item item, Map<K,V> map)	Converts a structurally typed item into a nominally typed Java object based on the provided prototype object.
Item	mold(Map<K,V> map)	Converts a nominally typed Java object into its structurally typed equivalent.
Item	mold(Map<K,V> map, Item item)	Converts a nominally typed Java object into its structurally typed equivalent based on the provided prototype item.
Class<?>	type()	Returns the reified Class of type T.
Map<K,V>	unit()	Returns a default–possibly null–value of type T.

Methods inherited from class swim.structure.Form

forArray, forBigInteger, forBoolean, forBuiltin, forByte, forByteBuffer, forCharacter, forClass, forClass, forCollection, forDouble, forFloat, forInteger, forItem, forList, forLong, forMap, forMap, forNumber, forSet, forShort, forString, forValue, isBuiltin, tag, tag, unit

Methods inherited from class java.lang.Object

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

Constructor Detail

MapForm

public MapForm(Class<?> type,
               Form<K> keyForm,
               Form<V> valForm)

Method Detail

unit

public Map<K,V> unit()

Description copied from class: Form

Returns a default–possibly null–value of type T. Used as the fallback return value when coercing an invalid structural value.

Overrides:

unit in class Form<Map<K,V>>

type

public Class<?> type()

Description copied from class: Form

Returns the reified Class of type T.

Specified by:

type in class Form<Map<K,V>>

mold

public Item mold(Map<K,V> map,
                 Item item)

Description copied from class: Form

Converts a nominally typed Java object into its structurally typed equivalent based on the provided prototype item. The passed-in item is assumed to be non-null. The returned Item must never be null.

Overrides:

mold in class Form<Map<K,V>>

mold

public Item mold(Map<K,V> map)

Description copied from class: Form

Converts a nominally typed Java object into its structurally typed equivalent. The returned Item must never be null.

Specified by:

mold in class Form<Map<K,V>>

cast

public Map<K,V> cast(Item item,
                           Map<K,V> map)

Description copied from class: Form

Converts a structurally typed item into a nominally typed Java object based on the provided prototype object. The passed-in item is assumed to be non-null. The passed-in prototype object may be null.

Overrides:

cast in class Form<Map<K,V>>

cast

public Map<K,V> cast(Item item)

Description copied from class: Form

Converts a structurally typed item into a nominally typed Java object. The passed-in item is assumed to be non-null.

Specified by:

cast in class Form<Map<K,V>>