net.morimekta.providence

Class PMessageBuilder<T extends PMessage<T>>

java.lang.Object

net.morimekta.providence.PMessageBuilder<T>

All Implemented Interfaces:

PBuilder<T>

Direct Known Subclasses:

ApplicationException._Builder

public abstract class PMessageBuilder<T extends PMessage<T>>
extends Object
implements PBuilder<T>

Base class for message builders.

Constructor Summary

Constructors

Constructor and Description
PMessageBuilder()

Method Summary

Modifier and Type	Method and Description
abstract PMessageBuilder<T>	addTo(int key, Object value) Adds a value to a set or list container.
abstract PMessageBuilder<T>	clear(int key) clear the provided field value.
abstract boolean	isValid() Checks if the current set data is enough to make a valid struct.
abstract PMessageBuilder<T>	merge(T from) Merges the provided message into the builder.
abstract PMessageBuilder<T>	set(int key, Object value) Set the provided field value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.PBuilder

build

Constructor Detail

PMessageBuilder

public PMessageBuilder()

Method Detail

isValid

public abstract boolean isValid()

Checks if the current set data is enough to make a valid struct. It will check for all required fields, and if any are missing it will return false.

Returns:

True for a valid message.

set

public abstract PMessageBuilder<T> set(int key,
                                       Object value)

Set the provided field value.

Parameters:

key - The field key.

value - The field value.

Returns:

The message builder.

addTo

public abstract PMessageBuilder<T> addTo(int key,
                                         Object value)

Adds a value to a set or list container.

Parameters:

key - The field key.

value - The field value to add.

Returns:

The message builder.

Throws:

IllegalArgumentException - if the field is not a list or set.

clear

public abstract PMessageBuilder<T> clear(int key)

clear the provided field value.

Parameters:

key - The field key.

Returns:

The message builder.

merge

public abstract PMessageBuilder<T> merge(T from)

Merges the provided message into the builder. Contained messages should in turn be merged and not replaced wholesale. Sets are unioned (addAll) and maps will overwrite / replace on a per-key basis (putAll).

Parameters:

from - The message to merge values from.