Package net.morimekta.providence.model
Class TypedefType._Builder
- java.lang.Object
-
- net.morimekta.providence.PMessageBuilder<TypedefType>
-
- net.morimekta.providence.model.TypedefType._Builder
-
- All Implemented Interfaces:
Decl
,Decl._Builder
,TypedefType_OrBuilder
,PMessageOrBuilder<TypedefType>
,PValue<TypedefType>
,BinaryReader
- Enclosing class:
- TypedefType
public static class TypedefType._Builder extends PMessageBuilder<TypedefType> implements Decl._Builder, TypedefType_OrBuilder, BinaryReader
typedef <type> <name>
-
-
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
-
-
Constructor Summary
Constructors Constructor Description _Builder()
Make a p_model.TypedefType builder instance._Builder(TypedefType base)
Make a mutating builder off a base p_model.TypedefType.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TypedefType._Builder
addTo(int key, java.lang.Object value)
Adds a value to a set or list container.TypedefType
build()
TypedefType._Builder
clear(int key)
Clear the provided field value.TypedefType._Builder
clearDocumentation()
Clear thedocumentation
field.TypedefType._Builder
clearName()
Clear thename
field.TypedefType._Builder
clearType()
Clear thetype
field.PStructDescriptor<TypedefType>
descriptor()
boolean
equals(java.lang.Object o)
<T> T
get(int key)
java.lang.String
getDocumentation()
Documentation for the specific declaration.java.lang.String
getName()
Name of the type, constant or service.java.lang.String
getType()
boolean
has(int key)
boolean
hasDocumentation()
Checks for presence of thedocumentation
field.int
hashCode()
boolean
hasName()
Checks for presence of thename
field.boolean
hasType()
Checks for presence of thetype
field.boolean
isModified(int key)
Checks if a specific field is modified on the builder.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
isModifiedType()
Checks if thetype
field has been modified since the builder was created.boolean
isSet(int key)
Checks if a specific field is set on the builder.boolean
isSetDocumentation()
Checks for explicit presence of thedocumentation
field.boolean
isSetName()
Checks for explicit presence of thename
field.boolean
isSetType()
Checks for explicit presence of thetype
field.TypedefType._Builder
merge(TypedefType from)
Merges the provided message into the builder.PMessageBuilder
mutator(int key)
Get the builder for the given message contained in this builder.java.util.Optional<java.lang.String>
optionalDocumentation()
Documentation for the specific declaration.void
readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)
Read the binary content into the current builder.TypedefType._Builder
set(int key, java.lang.Object value)
Set the provided field value.TypedefType._Builder
setDocumentation(java.lang.String value)
Set thedocumentation
field value.TypedefType._Builder
setName(java.lang.String value)
Set thename
field value.TypedefType._Builder
setType(java.lang.String value)
Set thetype
field value.boolean
valid()
Checks if the current set data is enough to make a valid struct.TypedefType._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.TypedefType builder instance.
-
_Builder
public _Builder(TypedefType base)
Make a mutating builder off a base p_model.TypedefType.- Parameters:
base
- The base TypedefType
-
-
Method Detail
-
merge
@Nonnull public TypedefType._Builder merge(TypedefType 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<TypedefType>
- Parameters:
from
- The message to merge values from.- Returns:
- The builder itself.
-
setDocumentation
@Nonnull public TypedefType._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 TypedefType._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
-
setType
@Nonnull public TypedefType._Builder setType(java.lang.String value)
Set thetype
field value.- Parameters:
value
- The new value- Returns:
- The builder
-
isSetType
public boolean isSetType()
Checks for explicit presence of thetype
field.- Returns:
- True if type has been set.
-
hasType
public boolean hasType()
Checks for presence of thetype
field.- Specified by:
hasType
in interfaceTypedefType_OrBuilder
- Returns:
- True if type is present.
-
isModifiedType
public boolean isModifiedType()
Checks if thetype
field has been modified since the builder was created.- Returns:
- True if type has been modified.
-
clearType
@Nonnull public TypedefType._Builder clearType()
Clear thetype
field.- Returns:
- The builder
-
getType
public java.lang.String getType()
- Specified by:
getType
in interfaceTypedefType_OrBuilder
- Returns:
- The
type
field value
-
setName
@Nonnull public TypedefType._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 TypedefType._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.
-
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<TypedefType>
- Parameters:
key
- The field key.- Returns:
- The field builder.
-
set
@Nonnull public TypedefType._Builder set(int key, java.lang.Object value)
Description copied from class:PMessageBuilder
Set the provided field value.- Specified by:
set
in classPMessageBuilder<TypedefType>
- 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<TypedefType>
- 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<TypedefType>
- 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<TypedefType>
- 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<TypedefType>
- Parameters:
key
- The key of the field.- Returns:
- Whether the field is present.
-
addTo
@Nonnull public TypedefType._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<TypedefType>
- Parameters:
key
- The key of the container field to add too.value
- The value to add.- Returns:
- The builder itself.
-
clear
@Nonnull public TypedefType._Builder clear(int key)
Description copied from class:PMessageBuilder
Clear the provided field value.- Specified by:
clear
in classPMessageBuilder<TypedefType>
- 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<TypedefType>
- Returns:
- True for a valid message.
-
validate
public TypedefType._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<TypedefType>
- Returns:
- The builder itself.
-
descriptor
@Nonnull public PStructDescriptor<TypedefType> descriptor()
- Specified by:
descriptor
in interfacePMessageOrBuilder<TypedefType>
- Specified by:
descriptor
in interfacePValue<TypedefType>
-
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 TypedefType build()
- Specified by:
build
in interfaceDecl._Builder
- Specified by:
build
in classPMessageBuilder<TypedefType>
- Returns:
- The built instance
-
-