net.morimekta.providence.descriptor

Class PList<Item>

java.lang.Object

net.morimekta.providence.descriptor.PContainer<List<Item>>

net.morimekta.providence.descriptor.PList<Item>

All Implemented Interfaces:

PDescriptor

public class PList<Item>
extends PContainer<List<Item>>

Descriptor for a list with item type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PList.Builder<I> Container builder used in serialization.
static class	PList.DefaultBuilder<I> Default builder returning an ImmutableList.

Constructor Summary

Constructors

Constructor and Description
PList(PDescriptorProvider itemType, Supplier<PList.Builder<Item>> builderSupplier)

Method Summary

Modifier and Type	Method and Description
PList.Builder<Item>	builder() Get an instance builder for the container.
boolean	equals(Object o)
Object	getDefaultValue()
String	getName() The name of the type is the Identifier string from the IDL.
String	getQualifiedName(String programContext) This will return the qualified name of the type given the program context.
PType	getType()
int	hashCode()
static <I> PContainerProvider<List<I>,PList<I>>	provider(PDescriptorProvider itemDesc)
static <I> PContainerProvider<List<I>,PList<I>>	provider(PDescriptorProvider itemDesc, Supplier<PList.Builder<I>> builderFactory)

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

getProgramName, itemDescriptor, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.descriptor.PDescriptor

getQualifiedName

Constructor Detail

PList

public PList(PDescriptorProvider itemType,
             Supplier<PList.Builder<Item>> builderSupplier)

Method Detail

getName

@Nonnull
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

@Nonnull
public String getQualifiedName(String programContext)

Description copied from interface: PDescriptor

This will return the qualified name of the type given the program context.

Parameters:

programContext - The program which the type should be referenced from.

Returns:

The qualified name of the type. Including program if not matching with programContext.

getType

@Nonnull
public PType getType()

Returns:

Get the field type.

getDefaultValue

@Nullable
public Object getDefaultValue()

Returns:

The default value for the type used for default and required fields. Note that some primitive types don't support null values, and will have methods returning a default value regardless of the field required value setting.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

@Nonnull
public PList.Builder<Item> builder()

Description copied from class: PContainer

Get an instance builder for the container.

Specified by:

builder in class PContainer<List<Item>>

Returns:

The instance builder.

provider

@Nonnull
public static <I> PContainerProvider<List<I>,PList<I>> provider(PDescriptorProvider itemDesc)

provider

@Nonnull
public static <I> PContainerProvider<List<I>,PList<I>> provider(PDescriptorProvider itemDesc,
                                                                         Supplier<PList.Builder<I>> builderFactory)