Declaration (Providence Generator : Common 2.6.1 API)

java.lang.Object
- net.morimekta.providence.model.Declaration

All Implemented Interfaces:

Serializable, Comparable<Declaration>, Decl, Declaration_OrBuilder, net.morimekta.providence.PMessage<Declaration>, net.morimekta.providence.PMessageOrBuilder<Declaration>, net.morimekta.providence.PUnion<Declaration>, net.morimekta.providence.PValue<Declaration>, net.morimekta.providence.serializer.binary.BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
 @Immutable
public class Declaration
extends Object
implements Decl, Declaration_OrBuilder, net.morimekta.providence.PUnion<Declaration>, Comparable<Declaration>, Serializable, net.morimekta.providence.serializer.binary.BinaryWriter
```
( <enum> | <typedef> | <struct> | <service> | <const> )

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Declaration._Builder
( <enum> | <typedef> | <struct> | <service> | <const> )

static class Declaration._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`Declaration._Builder` ( <enum> \| <typedef> \| <struct> \| <service> \| <const> )
`static class`	`Declaration._Field`

Field Summary

Fields
Modifier and Type Field and Description

static net.morimekta.providence.descriptor.PUnionDescriptor<Declaration> kDescriptor

Fields
Modifier and Type	Field and Description
`static net.morimekta.providence.descriptor.PUnionDescriptor<Declaration>`	`kDescriptor`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Decl`	`asDecl()`
`String`	`asString()`
`static Declaration._Builder`	`builder()` Make a `p_model.Declaration` builder.
`int`	`compareTo(Declaration other)`
`net.morimekta.providence.descriptor.PUnionDescriptor<Declaration>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`ConstType`	`getDeclConst()`
`EnumType`	`getDeclEnum()`
`MessageType`	`getDeclMessage()`
`ServiceType`	`getDeclService()`
`TypedefType`	`getDeclTypedef()`
`String`	`getDocumentation()` Documentation for the specific declaration.
`String`	`getName()` Name of the type, constant or service.
`boolean`	`has(int key)`
`boolean`	`hasDeclConst()`
`boolean`	`hasDeclEnum()`
`boolean`	`hasDeclMessage()`
`boolean`	`hasDeclService()`
`boolean`	`hasDeclTypedef()`
`boolean`	`hasDocumentation()`
`int`	`hashCode()`
`boolean`	`hasName()`
`Declaration._Builder`	`mutate()`
`Optional<ConstType>`	`optionalDeclConst()`
`Optional<EnumType>`	`optionalDeclEnum()`
`Optional<MessageType>`	`optionalDeclMessage()`
`Optional<ServiceType>`	`optionalDeclService()`
`Optional<TypedefType>`	`optionalDeclTypedef()`
`Optional<String>`	`optionalDocumentation()` Documentation for the specific declaration.
`static net.morimekta.providence.descriptor.PUnionDescriptorProvider<Declaration>`	`provider()`
`String`	`toString()`
`Declaration._Field`	`unionField()`
`boolean`	`unionFieldIsSet()`
`static Declaration`	`withDeclConst(ConstType_OrBuilder value)`
`static Declaration`	`withDeclEnum(EnumType_OrBuilder value)`
`static Declaration`	`withDeclMessage(MessageType_OrBuilder value)`
`static Declaration`	`withDeclService(ServiceType_OrBuilder value)`
`static Declaration`	`withDeclTypedef(TypedefType_OrBuilder value)`
`int`	`writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.morimekta.providence.PMessage
get, has, mergeWith

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder
toBuilder, toMessage

- Field Detail
  - kDescriptor
```
public static final net.morimekta.providence.descriptor.PUnionDescriptor<Declaration> kDescriptor
```
- Method Detail
  - withDeclEnum
```
@Nonnull
public static Declaration withDeclEnum(@Nonnull
                                                EnumType_OrBuilder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclTypedef
```
@Nonnull
public static Declaration withDeclTypedef(@Nonnull
                                                   TypedefType_OrBuilder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclMessage
```
@Nonnull
public static Declaration withDeclMessage(@Nonnull
                                                   MessageType_OrBuilder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclService
```
@Nonnull
public static Declaration withDeclService(@Nonnull
                                                   ServiceType_OrBuilder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclConst
```
@Nonnull
public static Declaration withDeclConst(@Nonnull
                                                 ConstType_OrBuilder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - hasDeclEnum
```
public boolean hasDeclEnum()
```
    Specified by:
    
    hasDeclEnum in interface Declaration_OrBuilder
    
    Returns:
    
    If decl_enum is present.
  - getDeclEnum
```
public EnumType getDeclEnum()
```
    Specified by:
    
    getDeclEnum in interface Declaration_OrBuilder
    
    Returns:
    
    The decl_enum value
  - optionalDeclEnum
```
@Nonnull
public Optional<EnumType> optionalDeclEnum()
```
    Specified by:
    
    optionalDeclEnum in interface Declaration_OrBuilder
    
    Returns:
    
    Optional of the decl_enum field value.
  - hasDeclTypedef
```
public boolean hasDeclTypedef()
```
    Specified by:
    
    hasDeclTypedef in interface Declaration_OrBuilder
    
    Returns:
    
    If decl_typedef is present.
  - getDeclTypedef
```
public TypedefType getDeclTypedef()
```
    Specified by:
    
    getDeclTypedef in interface Declaration_OrBuilder
    
    Returns:
    
    The decl_typedef value
  - optionalDeclTypedef
```
@Nonnull
public Optional<TypedefType> optionalDeclTypedef()
```
    Specified by:
    
    optionalDeclTypedef in interface Declaration_OrBuilder
    
    Returns:
    
    Optional of the decl_typedef field value.
  - hasDeclMessage
```
public boolean hasDeclMessage()
```
    Specified by:
    
    hasDeclMessage in interface Declaration_OrBuilder
    
    Returns:
    
    If decl_message is present.
  - getDeclMessage
```
public MessageType getDeclMessage()
```
    Specified by:
    
    getDeclMessage in interface Declaration_OrBuilder
    
    Returns:
    
    The decl_message value
  - optionalDeclMessage
```
@Nonnull
public Optional<MessageType> optionalDeclMessage()
```
    Specified by:
    
    optionalDeclMessage in interface Declaration_OrBuilder
    
    Returns:
    
    Optional of the decl_message field value.
  - hasDeclService
```
public boolean hasDeclService()
```
    Specified by:
    
    hasDeclService in interface Declaration_OrBuilder
    
    Returns:
    
    If decl_service is present.
  - getDeclService
```
public ServiceType getDeclService()
```
    Specified by:
    
    getDeclService in interface Declaration_OrBuilder
    
    Returns:
    
    The decl_service value
  - optionalDeclService
```
@Nonnull
public Optional<ServiceType> optionalDeclService()
```
    Specified by:
    
    optionalDeclService in interface Declaration_OrBuilder
    
    Returns:
    
    Optional of the decl_service field value.
  - hasDeclConst
```
public boolean hasDeclConst()
```
    Specified by:
    
    hasDeclConst in interface Declaration_OrBuilder
    
    Returns:
    
    If decl_const is present.
  - getDeclConst
```
public ConstType getDeclConst()
```
    Specified by:
    
    getDeclConst in interface Declaration_OrBuilder
    
    Returns:
    
    The decl_const value
  - optionalDeclConst
```
@Nonnull
public Optional<ConstType> optionalDeclConst()
```
    Specified by:
    
    optionalDeclConst in interface Declaration_OrBuilder
    
    Returns:
    
    Optional of the decl_const field value.
  - asDecl
```
public Decl asDecl()
```
    Returns:
    
    The union field as implemented type.
  - getDocumentation
```
public String getDocumentation()
```
    Documentation for the specific declaration.
    
    Specified by:
    
    getDocumentation in interface Decl
    
    Returns:
    
    The documentation value.
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Documentation for the specific declaration.
    
    Specified by:
    
    optionalDocumentation in interface Decl
    
    Returns:
    
    Optional documentation value.
  - hasDocumentation
```
public boolean hasDocumentation()
```
    Specified by:
    
    hasDocumentation in interface Decl
    
    Returns:
    
    If documentation is present.
  - getName
```
@Nonnull
public String getName()
```
    Name of the type, constant or service.
    
    Specified by:
    
    getName in interface Decl
    
    Returns:
    
    The name value.
  - hasName
```
public boolean hasName()
```
    Specified by:
    
    hasName in interface Decl
    
    Returns:
    
    If name is present.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<Declaration>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<Declaration>
  - unionFieldIsSet
```
public boolean unionFieldIsSet()
```
    Specified by:
    
    unionFieldIsSet in interface net.morimekta.providence.PUnion<Declaration>
  - unionField
```
@Nonnull
public Declaration._Field unionField()
```
    Specified by:
    
    unionField in interface net.morimekta.providence.PUnion<Declaration>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asString
```
@Nonnull
public String asString()
```
    Specified by:
    
    asString in interface net.morimekta.providence.PMessage<Declaration>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(Declaration other)
```
    Specified by:
    
    compareTo in interface Comparable<Declaration>
  - writeBinary
```
public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
                throws IOException
```
    Specified by:
    
    writeBinary in interface net.morimekta.providence.serializer.binary.BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public Declaration._Builder mutate()
```
    Specified by:
    
    mutate in interface net.morimekta.providence.PMessage<Declaration>
  - provider
```
@Nonnull
public static net.morimekta.providence.descriptor.PUnionDescriptorProvider<Declaration> provider()
```
  - descriptor
```
@Nonnull
public net.morimekta.providence.descriptor.PUnionDescriptor<Declaration> descriptor()
```
    Specified by:
    
    descriptor in interface net.morimekta.providence.PMessageOrBuilder<Declaration>
    
    Specified by:
    
    descriptor in interface net.morimekta.providence.PValue<Declaration>
  - builder
```
public static Declaration._Builder builder()
```
    Make a p_model.Declaration builder.
    
    Returns:
    
    The builder instance.

Class Declaration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.morimekta.providence.PMessage

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder

Field Detail

kDescriptor

Method Detail

withDeclEnum

withDeclTypedef

withDeclMessage

withDeclService

withDeclConst

hasDeclEnum

getDeclEnum

optionalDeclEnum

hasDeclTypedef

getDeclTypedef

optionalDeclTypedef

hasDeclMessage

getDeclMessage

optionalDeclMessage

hasDeclService

getDeclService

optionalDeclService

hasDeclConst

getDeclConst

optionalDeclConst

asDecl

getDocumentation

optionalDocumentation

hasDocumentation

getName

hasName

has

get

unionFieldIsSet

unionField

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder