net.morimekta.providence.model

Class MessageType._Builder

java.lang.Object

net.morimekta.providence.PMessageBuilder<MessageType,MessageType._Field>

net.morimekta.providence.model.MessageType._Builder

All Implemented Interfaces:

PBuilder<MessageType>, BinaryReader

Enclosing class:

MessageType

public static class MessageType._Builder
extends PMessageBuilder<MessageType,MessageType._Field>
implements BinaryReader

<variant> { (<field> ([,;])?)* }

Constructor Summary

Constructors

Constructor and Description
_Builder() Make a model.MessageType builder.
_Builder(MessageType base) Make a mutating builder off a base model.MessageType.

Method Summary

Modifier and Type	Method and Description
MessageType._Builder	addTo(int key, Object value)
MessageType._Builder	addToFields(FieldType... values) Adds entries to fields.
MessageType	build()
MessageType._Builder	clear(int key)
MessageType._Builder	clearAnnotations() Clears the annotations field.
MessageType._Builder	clearDocumentation() Clears the documentation field.
MessageType._Builder	clearFields() Clears the fields field.
MessageType._Builder	clearName() Clears the name field.
MessageType._Builder	clearVariant() Clears the variant field.
PStructDescriptor<MessageType,MessageType._Field>	descriptor()
boolean	equals(Object o)
String	getDocumentation() Gets the value of the contained documentation.
String	getName() Gets the value of the contained name.
MessageVariant	getVariant() Gets the value of the contained variant.
int	hashCode()
boolean	isModified(int key)
boolean	isModifiedAnnotations() Checks if annotations has been modified since the _Builder was created.
boolean	isModifiedDocumentation() Checks if documentation has been modified since the _Builder was created.
boolean	isModifiedFields() Checks if fields has been modified since the _Builder was created.
boolean	isModifiedName() Checks if name has been modified since the _Builder was created.
boolean	isModifiedVariant() Checks if variant has been modified since the _Builder was created.
boolean	isSet(int key)
boolean	isSetAnnotations() Checks for presence of the annotations field.
boolean	isSetDocumentation() Checks for presence of the documentation field.
boolean	isSetFields() Checks for presence of the fields field.
boolean	isSetName() Checks for presence of the name field.
boolean	isSetVariant() Checks for presence of the variant field.
MessageType._Builder	merge(MessageType from)
Map<String,String>	mutableAnnotations() Gets the builder for the contained annotations.
List<FieldType>	mutableFields() Gets the builder for the contained fields.
PMessageBuilder	mutator(int key)
MessageType._Builder	putInAnnotations(String key, String value) Adds a mapping to annotations.
void	readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)
MessageType._Builder	set(int key, Object value)
MessageType._Builder	setAnnotations(Map<String,String> value) Sets the value of annotations.
MessageType._Builder	setDocumentation(String value) Sets the value of documentation.
MessageType._Builder	setFields(Collection<FieldType> value) Sets the value of fields.
MessageType._Builder	setName(String value) Sets the value of name.
MessageType._Builder	setVariant(MessageVariant value) Sets the value of variant.
boolean	valid()
void	validate()

Methods inherited from class net.morimekta.providence.PMessageBuilder

addTo, clear, isModified, isSet, modifiedFields, mutator, presentFields, set

Methods inherited from class java.lang.Object

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

Constructor Detail

_Builder

public _Builder()

Make a model.MessageType builder.

_Builder

public _Builder(MessageType base)

Make a mutating builder off a base model.MessageType.

Parameters:

base - The base MessageType

Method Detail

merge

@Nonnull
public MessageType._Builder merge(MessageType from)

Specified by:

merge in class PMessageBuilder<MessageType,MessageType._Field>

setDocumentation

@Nonnull
public MessageType._Builder setDocumentation(String value)

Sets the value of documentation.

Parameters:

value - The new value

Returns:

The builder

isSetDocumentation

public boolean isSetDocumentation()

Checks for presence of the documentation field.

Returns:

True if documentation has been set.

isModifiedDocumentation

public boolean isModifiedDocumentation()

Checks if documentation has been modified since the _Builder was created.

Returns:

True if documentation has been modified.

clearDocumentation

@Nonnull
public MessageType._Builder clearDocumentation()

Clears the documentation field.

Returns:

The builder

getDocumentation

public String getDocumentation()

Gets the value of the contained documentation.

Returns:

The field value

setVariant

@Nonnull
public MessageType._Builder setVariant(MessageVariant value)

Sets the value of variant.

Parameters:

value - The new value

Returns:

The builder

isSetVariant

public boolean isSetVariant()

Checks for presence of the variant field.

Returns:

True if variant has been set.

isModifiedVariant

public boolean isModifiedVariant()

Checks if variant has been modified since the _Builder was created.

Returns:

True if variant has been modified.

clearVariant

@Nonnull
public MessageType._Builder clearVariant()

Clears the variant field.

Returns:

The builder

getVariant

public MessageVariant getVariant()

Gets the value of the contained variant.

Returns:

The field value

setName

@Nonnull
public MessageType._Builder setName(String value)

Sets the value of name.

Parameters:

value - The new value

Returns:

The builder

isSetName

public boolean isSetName()

Checks for presence of the name field.

Returns:

True if name has been set.

isModifiedName

public boolean isModifiedName()

Checks if name has been modified since the _Builder was created.

Returns:

True if name has been modified.

clearName

@Nonnull
public MessageType._Builder clearName()

Clears the name field.

Returns:

The builder

getName

public String getName()

Gets the value of the contained name.

Returns:

The field value

setFields

@Nonnull
public MessageType._Builder setFields(Collection<FieldType> value)

Sets the value of fields.

Parameters:

value - The new value

Returns:

The builder

addToFields

@Nonnull
public MessageType._Builder addToFields(FieldType... values)

Adds entries to fields.

Parameters:

values - The added value

Returns:

The builder

isSetFields

public boolean isSetFields()

Checks for presence of the fields field.

Returns:

True if fields has been set.

isModifiedFields

public boolean isModifiedFields()

Checks if fields has been modified since the _Builder was created.

Returns:

True if fields has been modified.

clearFields

@Nonnull
public MessageType._Builder clearFields()

Clears the fields field.

Returns:

The builder

mutableFields

@Nonnull
public List<FieldType> mutableFields()

Gets the builder for the contained fields.

Returns:

The field builder

setAnnotations

@Nonnull
public MessageType._Builder setAnnotations(Map<String,String> value)

Sets the value of annotations.

Parameters:

value - The new value

Returns:

The builder

putInAnnotations

@Nonnull
public MessageType._Builder putInAnnotations(String key,
                                                      String value)

Adds a mapping to annotations.

Parameters:

key - The inserted key

value - The inserted value

Returns:

The builder

isSetAnnotations

public boolean isSetAnnotations()

Checks for presence of the annotations field.

Returns:

True if annotations has been set.

isModifiedAnnotations

public boolean isModifiedAnnotations()

Checks if annotations has been modified since the _Builder was created.

Returns:

True if annotations has been modified.

clearAnnotations

@Nonnull
public MessageType._Builder clearAnnotations()

Clears the annotations field.

Returns:

The builder

mutableAnnotations

@Nonnull
public Map<String,String> mutableAnnotations()

Gets the builder for the contained annotations.

Returns:

The field builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

mutator

public PMessageBuilder mutator(int key)

Specified by:

mutator in class PMessageBuilder<MessageType,MessageType._Field>

set

@Nonnull
public MessageType._Builder set(int key,
                                         Object value)

Specified by:

set in class PMessageBuilder<MessageType,MessageType._Field>

isSet

public boolean isSet(int key)

Specified by:

isSet in class PMessageBuilder<MessageType,MessageType._Field>

isModified

public boolean isModified(int key)

Specified by:

isModified in class PMessageBuilder<MessageType,MessageType._Field>

addTo

public MessageType._Builder addTo(int key,
                                  Object value)

Specified by:

addTo in class PMessageBuilder<MessageType,MessageType._Field>

clear

@Nonnull
public MessageType._Builder clear(int key)

Specified by:

clear in class PMessageBuilder<MessageType,MessageType._Field>

valid

public boolean valid()

Specified by:

valid in class PMessageBuilder<MessageType,MessageType._Field>

validate

public void validate()

Specified by:

validate in class PMessageBuilder<MessageType,MessageType._Field>

descriptor

@Nonnull
public PStructDescriptor<MessageType,MessageType._Field> descriptor()

Specified by:

descriptor in class PMessageBuilder<MessageType,MessageType._Field>

readBinary

public void readBinary(net.morimekta.util.io.BigEndianBinaryReader reader,
                       boolean strict)
                throws IOException

Specified by:

readBinary in interface BinaryReader

Throws:

IOException

build

public MessageType build()

Specified by:

build in interface PBuilder<MessageType>