net.morimekta.providence.descriptor

Class PMap<K,V>

java.lang.Object

net.morimekta.providence.descriptor.PContainer<Map<K,V>>

net.morimekta.providence.descriptor.PMap<K,V>

All Implemented Interfaces:

PDescriptor

public class PMap<K,V>
extends PContainer<Map<K,V>>

Descriptor for a map with key and item type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PMap.Builder<K,V>
static class	PMap.ImmutableMapBuilder<K,V>
static class	PMap.ImmutableSortedMapBuilder<K extends Comparable,V>
static class	PMap.LinkedHashMapBuilder<K,V>

Constructor Summary

Constructors

Constructor and Description
PMap(PDescriptorProvider keyDesc, PDescriptorProvider itemDesc, net.morimekta.providence.descriptor.PMap.BuilderFactory<K,V> builderFactory)

Method Summary

Modifier and Type	Method and Description
PMap.Builder<K,V>	builder() Get an instance builder for the container.
boolean	equals(Object o)
String	getName() The name of the type is the Identifier string from the IDL.
String	getQualifiedName(String packageName) This will return the qualifying name of the type given package context.
PType	getType()
int	hashCode()
PDescriptor	keyDescriptor()
static <K,V> PContainerProvider<Map<K,V>,PMap<K,V>>	orderedProvider(PDescriptorProvider keyDesc, PDescriptorProvider itemDesc)
static <K,V> PContainerProvider<Map<K,V>,PMap<K,V>>	provider(PDescriptorProvider keyDesc, PDescriptorProvider itemDesc)
static <K extends Comparable<K>,V> PContainerProvider<Map<K,V>,PMap<K,V>>	sortedProvider(PDescriptorProvider keyDesc, PDescriptorProvider itemDesc)

Methods inherited from class net.morimekta.providence.descriptor.PContainer

getPackageName, itemDescriptor, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PMap

public PMap(PDescriptorProvider keyDesc,
            PDescriptorProvider itemDesc,
            net.morimekta.providence.descriptor.PMap.BuilderFactory<K,V> builderFactory)

Method Detail

keyDescriptor

public PDescriptor keyDescriptor()

getName

public String getName()

Description copied from interface: PDescriptor

The name of the type is the Identifier string from the IDL.

Returns:

The name of the type. Not including package.

getQualifiedName

public String getQualifiedName(String packageName)

Description copied from interface: PDescriptor

This will return the qualifying name of the type given package context.

Parameters:

packageName - The package which the name should be referenced from.

Returns:

The name of the type. Including package if not matching with packageContext.

getType

public PType getType()

Returns:

Get the field type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public PMap.Builder<K,V> builder()

Description copied from class: PContainer

Get an instance builder for the container.

Specified by:

builder in class PContainer<Map<K,V>>

Returns:

The instance builder.

provider

public static <K,V> PContainerProvider<Map<K,V>,PMap<K,V>> provider(PDescriptorProvider keyDesc,
                                                                    PDescriptorProvider itemDesc)

sortedProvider

public static <K extends Comparable<K>,V> PContainerProvider<Map<K,V>,PMap<K,V>> sortedProvider(PDescriptorProvider keyDesc,
                                                                                                PDescriptorProvider itemDesc)

orderedProvider

public static <K,V> PContainerProvider<Map<K,V>,PMap<K,V>> orderedProvider(PDescriptorProvider keyDesc,
                                                                           PDescriptorProvider itemDesc)