Package net.morimekta.providence.model
Class EnumType._Builder
- java.lang.Object
-
- net.morimekta.providence.PMessageBuilder<EnumType>
-
- net.morimekta.providence.model.EnumType._Builder
-
- All Implemented Interfaces:
Decl
,Decl._Builder
,EnumType_OrBuilder
,PMessageOrBuilder<EnumType>
,PValue<EnumType>
,BinaryReader
- Enclosing class:
- EnumType
public static class EnumType._Builder extends PMessageBuilder<EnumType> implements Decl._Builder, EnumType_OrBuilder, BinaryReader
enum { (<value> ([;,])?)* }
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.morimekta.providence.model.Decl
Decl._Builder, Decl._Field
-
-
Field Summary
-
Fields inherited from interface net.morimekta.providence.model.Decl
kDescriptor
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnumType._Builder
addTo(int key, java.lang.Object value)
Adds a value to a set or list container.EnumType._Builder
addToValues(EnumValue... values)
Adds entries to thevalues
list.EnumType
build()
EnumType._Builder
clear(int key)
Clear the provided field value.EnumType._Builder
clearAnnotations()
Clear theannotations
field.EnumType._Builder
clearDocumentation()
Clear thedocumentation
field.EnumType._Builder
clearName()
Clear thename
field.EnumType._Builder
clearValues()
Clear thevalues
field.PStructDescriptor<EnumType>
descriptor()
boolean
equals(java.lang.Object o)
<T> T
get(int key)
java.util.Map<java.lang.String,java.lang.String>
getAnnotations()
java.lang.String
getDocumentation()
Documentation for the specific declaration.java.lang.String
getName()
Name of the type, constant or service.java.util.List<EnumValue>
getValues()
boolean
has(int key)
boolean
hasAnnotations()
Checks for presence of theannotations
field.boolean
hasDocumentation()
Checks for presence of thedocumentation
field.int
hashCode()
boolean
hasName()
Checks for presence of thename
field.boolean
hasValues()
Checks for presence of thevalues
field.boolean
isModified(int key)
Checks if a specific field is modified on the builder.boolean
isModifiedAnnotations()
Checks if theannotations
field has been modified since the builder was created.boolean
isModifiedDocumentation()
Checks if thedocumentation
field has been modified since the builder was created.boolean
isModifiedName()
Checks if thename
field has been modified since the builder was created.boolean
isModifiedValues()
Checks if thevalues
field has been modified since the builder was created.boolean
isSet(int key)
Checks if a specific field is set on the builder.boolean
isSetAnnotations()
Checks for explicit presence of theannotations
field.boolean
isSetDocumentation()
Checks for explicit presence of thedocumentation
field.boolean
isSetName()
Checks for explicit presence of thename
field.boolean
isSetValues()
Checks for explicit presence of thevalues
field.EnumType._Builder
merge(EnumType from)
Merges the provided message into the builder.java.util.Map<java.lang.String,java.lang.String>
mutableAnnotations()
java.util.List<EnumValue>
mutableValues()
PMessageBuilder
mutator(int key)
Get the builder for the given message contained in this builder.int
numAnnotations()
int
numValues()
java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>
optionalAnnotations()
java.util.Optional<java.lang.String>
optionalDocumentation()
Documentation for the specific declaration.EnumType._Builder
putInAnnotations(java.lang.String key, java.lang.String value)
Adds a mapping to theannotations
map.void
readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)
Read the binary content into the current builder.EnumType._Builder
set(int key, java.lang.Object value)
Set the provided field value.EnumType._Builder
setAnnotations(java.util.Map<java.lang.String,java.lang.String> value)
Set theannotations
field value.EnumType._Builder
setDocumentation(java.lang.String value)
Set thedocumentation
field value.EnumType._Builder
setName(java.lang.String value)
Set thename
field value.EnumType._Builder
setValues(java.util.Collection<EnumValue> value)
Set thevalues
field value.boolean
valid()
Checks if the current set data is enough to make a valid struct.EnumType._Builder
validate()
Checks if the current set data is enough to make a valid struct.-
Methods inherited from class net.morimekta.providence.PMessageBuilder
addTo, clear, isModified, isSet, modifiedFieldNames, modifiedFields, mutator, presentFieldNames, presentFields, set
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.morimekta.providence.PMessageOrBuilder
get, has, toBuilder, toMessage
-
-
-
-
Constructor Detail
-
_Builder
public _Builder()
Make a p_model.EnumType builder instance.
-
_Builder
public _Builder(EnumType base)
Make a mutating builder off a base p_model.EnumType.- Parameters:
base
- The base EnumType
-
-
Method Detail
-
merge
@Nonnull public EnumType._Builder merge(EnumType from)
Description copied from class:PMessageBuilder
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).- Specified by:
merge
in classPMessageBuilder<EnumType>
- Parameters:
from
- The message to merge values from.- Returns:
- The builder itself.
-
setDocumentation
@Nonnull public EnumType._Builder setDocumentation(java.lang.String value)
Set thedocumentation
field value.- Specified by:
setDocumentation
in interfaceDecl._Builder
- Parameters:
value
- The new value- Returns:
- The builder
-
isSetDocumentation
public boolean isSetDocumentation()
Checks for explicit presence of thedocumentation
field.- Returns:
- True if documentation has been set.
-
hasDocumentation
public boolean hasDocumentation()
Checks for presence of thedocumentation
field.- Specified by:
hasDocumentation
in interfaceDecl
- Returns:
- True if documentation is present.
-
isModifiedDocumentation
public boolean isModifiedDocumentation()
Checks if thedocumentation
field has been modified since the builder was created.- Returns:
- True if documentation has been modified.
-
clearDocumentation
@Nonnull public EnumType._Builder clearDocumentation()
Clear thedocumentation
field.- Specified by:
clearDocumentation
in interfaceDecl._Builder
- Returns:
- The builder
-
getDocumentation
public java.lang.String getDocumentation()
Description copied from interface:Decl
Documentation for the specific declaration.- Specified by:
getDocumentation
in interfaceDecl
- Returns:
- The
documentation
field value
-
optionalDocumentation
@Nonnull public java.util.Optional<java.lang.String> optionalDocumentation()
Description copied from interface:Decl
Documentation for the specific declaration.- Specified by:
optionalDocumentation
in interfaceDecl
- Returns:
- Optional
documentation
field value
-
setName
@Nonnull public EnumType._Builder setName(java.lang.String value)
Set thename
field value.- Specified by:
setName
in interfaceDecl._Builder
- Parameters:
value
- The new value- Returns:
- The builder
-
isSetName
public boolean isSetName()
Checks for explicit presence of thename
field.- Returns:
- True if name has been set.
-
hasName
public boolean hasName()
Checks for presence of thename
field.
-
isModifiedName
public boolean isModifiedName()
Checks if thename
field has been modified since the builder was created.- Returns:
- True if name has been modified.
-
clearName
@Nonnull public EnumType._Builder clearName()
Clear thename
field.- Specified by:
clearName
in interfaceDecl._Builder
- Returns:
- The builder
-
getName
public java.lang.String getName()
Description copied from interface:Decl
Name of the type, constant or service.
-
setValues
@Nonnull public EnumType._Builder setValues(java.util.Collection<EnumValue> value)
Set thevalues
field value.- Parameters:
value
- The new value- Returns:
- The builder
-
addToValues
@Nonnull public EnumType._Builder addToValues(EnumValue... values)
Adds entries to thevalues
list.- Parameters:
values
- The added value- Returns:
- The builder
-
isSetValues
public boolean isSetValues()
Checks for explicit presence of thevalues
field.- Returns:
- True if values has been set.
-
hasValues
public boolean hasValues()
Checks for presence of thevalues
field.- Specified by:
hasValues
in interfaceEnumType_OrBuilder
- Returns:
- True if values is present.
-
isModifiedValues
public boolean isModifiedValues()
Checks if thevalues
field has been modified since the builder was created.- Returns:
- True if values has been modified.
-
clearValues
@Nonnull public EnumType._Builder clearValues()
Clear thevalues
field.- Returns:
- The builder
-
mutableValues
public java.util.List<EnumValue> mutableValues()
- Returns:
- The mutable
values
container
-
getValues
public java.util.List<EnumValue> getValues()
- Specified by:
getValues
in interfaceEnumType_OrBuilder
- Returns:
- The
values
field value
-
numValues
public int numValues()
- Specified by:
numValues
in interfaceEnumType_OrBuilder
- Returns:
- Number of entries in
values
.
-
setAnnotations
@Nonnull public EnumType._Builder setAnnotations(java.util.Map<java.lang.String,java.lang.String> value)
Set theannotations
field value.- Parameters:
value
- The new value- Returns:
- The builder
-
putInAnnotations
@Nonnull public EnumType._Builder putInAnnotations(java.lang.String key, java.lang.String value)
Adds a mapping to theannotations
map.- Parameters:
key
- The inserted keyvalue
- The inserted value- Returns:
- The builder
-
isSetAnnotations
public boolean isSetAnnotations()
Checks for explicit presence of theannotations
field.- Returns:
- True if annotations has been set.
-
hasAnnotations
public boolean hasAnnotations()
Checks for presence of theannotations
field.- Specified by:
hasAnnotations
in interfaceEnumType_OrBuilder
- Returns:
- True if annotations is present.
-
isModifiedAnnotations
public boolean isModifiedAnnotations()
Checks if theannotations
field has been modified since the builder was created.- Returns:
- True if annotations has been modified.
-
clearAnnotations
@Nonnull public EnumType._Builder clearAnnotations()
Clear theannotations
field.- Returns:
- The builder
-
mutableAnnotations
public java.util.Map<java.lang.String,java.lang.String> mutableAnnotations()
- Returns:
- The mutable
annotations
container
-
getAnnotations
public java.util.Map<java.lang.String,java.lang.String> getAnnotations()
- Specified by:
getAnnotations
in interfaceEnumType_OrBuilder
- Returns:
- The
annotations
field value
-
optionalAnnotations
@Nonnull public java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> optionalAnnotations()
- Specified by:
optionalAnnotations
in interfaceEnumType_OrBuilder
- Returns:
- Optional
annotations
field value
-
numAnnotations
public int numAnnotations()
- Specified by:
numAnnotations
in interfaceEnumType_OrBuilder
- Returns:
- Number of entries in
annotations
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
mutator
public PMessageBuilder mutator(int key)
Description copied from class:PMessageBuilder
Get the builder for the given message contained in this builder. If the sub-builder does not exist, create, either from existing instance or from scratch.- Specified by:
mutator
in classPMessageBuilder<EnumType>
- Parameters:
key
- The field key.- Returns:
- The field builder.
-
set
@Nonnull public EnumType._Builder set(int key, java.lang.Object value)
Description copied from class:PMessageBuilder
Set the provided field value.- Specified by:
set
in classPMessageBuilder<EnumType>
- Parameters:
key
- The key of the field to set.value
- The value to be set.- Returns:
- The message builder.
-
isSet
public boolean isSet(int key)
Description copied from class:PMessageBuilder
Checks if a specific field is set on the builder.- Specified by:
isSet
in classPMessageBuilder<EnumType>
- Parameters:
key
- The key of the field to check.- Returns:
- True if the field is set.
-
isModified
public boolean isModified(int key)
Description copied from class:PMessageBuilder
Checks if a specific field is modified on the builder.- Specified by:
isModified
in classPMessageBuilder<EnumType>
- Parameters:
key
- The key of the field to check.- Returns:
- True if the field is modified.
-
get
public <T> T get(int key)
- Specified by:
get
in interfacePMessageOrBuilder<EnumType>
- Type Parameters:
T
- The return type.- Parameters:
key
- The key of the field.- Returns:
- The value of the field.
-
has
public boolean has(int key)
- Specified by:
has
in interfacePMessageOrBuilder<EnumType>
- Parameters:
key
- The key of the field.- Returns:
- Whether the field is present.
-
addTo
@Nonnull public EnumType._Builder addTo(int key, java.lang.Object value)
Description copied from class:PMessageBuilder
Adds a value to a set or list container.- Specified by:
addTo
in classPMessageBuilder<EnumType>
- Parameters:
key
- The key of the container field to add too.value
- The value to add.- Returns:
- The builder itself.
-
clear
@Nonnull public EnumType._Builder clear(int key)
Description copied from class:PMessageBuilder
Clear the provided field value.- Specified by:
clear
in classPMessageBuilder<EnumType>
- Parameters:
key
- The key of the field to clear.- Returns:
- The builder itself.
-
valid
public boolean valid()
Description copied from class:PMessageBuilder
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.- Specified by:
valid
in classPMessageBuilder<EnumType>
- Returns:
- True for a valid message.
-
validate
public EnumType._Builder validate()
Description copied from class:PMessageBuilder
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 throw anIllegalStateException
with an appropriate error message.- Specified by:
validate
in classPMessageBuilder<EnumType>
- Returns:
- The builder itself.
-
descriptor
@Nonnull public PStructDescriptor<EnumType> descriptor()
- Specified by:
descriptor
in interfacePMessageOrBuilder<EnumType>
- Specified by:
descriptor
in interfacePValue<EnumType>
-
readBinary
public void readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict) throws java.io.IOException
Description copied from interface:BinaryReader
Read the binary content into the current builder. NOTE: This method is not intended to be used directly. Instead use theBinarySerializer.deserialize(InputStream, PMessageDescriptor)
call.- Specified by:
readBinary
in interfaceBinaryReader
- Parameters:
reader
- The reader to read from.strict
- If content should be handled strictly. True means to fail on everything that Apache thrift failed read() on.- Throws:
java.io.IOException
- When unable to read message for any reason.
-
build
@Nonnull public EnumType build()
- Specified by:
build
in interfaceDecl._Builder
- Specified by:
build
in classPMessageBuilder<EnumType>
- Returns:
- The built instance
-
-