net.morimekta.providence

Interface PMessage<Message extends PMessage<Message,Field>,Field extends PField>

All Superinterfaces:

Comparable<Message>, PValue<Message>, net.morimekta.util.Stringable

All Known Subinterfaces:

PUnion<Union,Field>

All Known Implementing Classes:

PApplicationException

public interface PMessage<Message extends PMessage<Message,Field>,Field extends PField>
extends PValue<Message>, net.morimekta.util.Stringable

Base class for all messages.

Since:

25.08.15

Author:

Stein Eldar Johnsen

Method Summary

Modifier and Type	Method and Description
String	asString() Pure string representation of content.
PMessageDescriptor<Message,Field>	descriptor()
default Object	get(Field field)
Object	get(int key)
default boolean	has(Field field)
boolean	has(int key)
default Message	mergeWith(Message other) Shorthand for merging two messages.
PMessageBuilder<Message,Field>	mutate() Get a builder that extends the current object.
default int	num(Field field)
int	num(int key)

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

has

boolean has(int key)

Parameters:

key - The key of the field.

Returns:

Whether the field is present.

has

default boolean has(@Nonnull
                    Field field)

Parameters:

field - The field.

Returns:

Whether the field is present.

num

int num(int key)

Parameters:

key - The key of the field.

Returns:

Number of values for the field.

num

default int num(@Nonnull
                Field field)

Parameters:

field - The field.

Returns:

Whether the field is present.

get

Object get(int key)

Parameters:

key - The key of the field.

Returns:

The value of the field.

get

default Object get(@Nonnull
                   Field field)

Parameters:

field - The field.

Returns:

Whether the field is present.

mutate

@Nonnull
PMessageBuilder<Message,Field> mutate()

Get a builder that extends the current object.

Returns:

The builder instance.

mergeWith

@Nonnull
default Message mergeWith(Message other)

Shorthand for merging two messages.

Parameters:

other - The message to merge over this messages' values.

Returns:

The merged message.

asString

@Nonnull
String asString()

Pure string representation of content. Does not contain type info.

Specified by:

asString in interface net.morimekta.util.Stringable

Returns:

String representation.

descriptor

@Nonnull
PMessageDescriptor<Message,Field> descriptor()

Specified by:

descriptor in interface PValue<Message extends PMessage<Message,Field>>