Declaration (Providence Utils : Reflection 1.5.2 API)

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

All Implemented Interfaces:

Serializable, Comparable<Declaration>, PMessage<Declaration,Declaration._Field>, PUnion<Declaration,Declaration._Field>, PValue<Declaration>, BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="providence-maven-plugin")
 @Immutable
public class Declaration
extends Object
implements PUnion<Declaration,Declaration._Field>, Comparable<Declaration>, Serializable, 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 PUnionDescriptor<Declaration,Declaration._Field> kDescriptor

Fields
Modifier and Type	Field and Description
`static PUnionDescriptor<Declaration,Declaration._Field>`	`kDescriptor`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static Declaration._Builder`	`builder()` Make a model.Declaration builder.
`int`	`compareTo(Declaration other)`
`PUnionDescriptor<Declaration,Declaration._Field>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`ConstType`	`getDeclConst()`
`EnumType`	`getDeclEnum()`
`ServiceType`	`getDeclService()`
`MessageType`	`getDeclStruct()`
`TypedefType`	`getDeclTypedef()`
`boolean`	`has(int key)`
`boolean`	`hasDeclConst()`
`boolean`	`hasDeclEnum()`
`boolean`	`hasDeclService()`
`boolean`	`hasDeclStruct()`
`boolean`	`hasDeclTypedef()`
`int`	`hashCode()`
`Declaration._Builder`	`mutate()`
`Optional<ConstType>`	`optionalDeclConst()`
`Optional<EnumType>`	`optionalDeclEnum()`
`Optional<ServiceType>`	`optionalDeclService()`
`Optional<MessageType>`	`optionalDeclStruct()`
`Optional<TypedefType>`	`optionalDeclTypedef()`
`static PUnionDescriptorProvider<Declaration,Declaration._Field>`	`provider()`
`String`	`toString()`
`Declaration._Field`	`unionField()`
`boolean`	`unionFieldIsSet()`
`static Declaration`	`withDeclConst(ConstType._Builder value)`
`static Declaration`	`withDeclConst(ConstType value)`
`static Declaration`	`withDeclEnum(EnumType._Builder value)`
`static Declaration`	`withDeclEnum(EnumType value)`
`static Declaration`	`withDeclService(ServiceType._Builder value)`
`static Declaration`	`withDeclService(ServiceType value)`
`static Declaration`	`withDeclStruct(MessageType._Builder value)`
`static Declaration`	`withDeclStruct(MessageType value)`
`static Declaration`	`withDeclTypedef(TypedefType._Builder value)`
`static Declaration`	`withDeclTypedef(TypedefType 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

- Field Detail
  - kDescriptor
```
public static final PUnionDescriptor<Declaration,Declaration._Field> kDescriptor
```
- Method Detail
  - withDeclEnum
```
public static Declaration withDeclEnum(EnumType value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclEnum
```
public static Declaration withDeclEnum(EnumType._Builder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclTypedef
```
public static Declaration withDeclTypedef(TypedefType value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclTypedef
```
public static Declaration withDeclTypedef(TypedefType._Builder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclStruct
```
public static Declaration withDeclStruct(MessageType value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclStruct
```
public static Declaration withDeclStruct(MessageType._Builder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclService
```
public static Declaration withDeclService(ServiceType value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclService
```
public static Declaration withDeclService(ServiceType._Builder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclConst
```
public static Declaration withDeclConst(ConstType value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - withDeclConst
```
public static Declaration withDeclConst(ConstType._Builder value)
```
    Parameters:
    
    value - The union value
    
    Returns:
    
    The created union.
  - hasDeclEnum
```
public boolean hasDeclEnum()
```
  - getDeclEnum
```
public EnumType getDeclEnum()
```
    Returns:
    
    The field value
  - optionalDeclEnum
```
@Nonnull
public Optional<EnumType> optionalDeclEnum()
```
    Returns:
    
    Optional field value
  - hasDeclTypedef
```
public boolean hasDeclTypedef()
```
  - getDeclTypedef
```
public TypedefType getDeclTypedef()
```
    Returns:
    
    The field value
  - optionalDeclTypedef
```
@Nonnull
public Optional<TypedefType> optionalDeclTypedef()
```
    Returns:
    
    Optional field value
  - hasDeclStruct
```
public boolean hasDeclStruct()
```
  - getDeclStruct
```
public MessageType getDeclStruct()
```
    Returns:
    
    The field value
  - optionalDeclStruct
```
@Nonnull
public Optional<MessageType> optionalDeclStruct()
```
    Returns:
    
    Optional field value
  - hasDeclService
```
public boolean hasDeclService()
```
  - getDeclService
```
public ServiceType getDeclService()
```
    Returns:
    
    The field value
  - optionalDeclService
```
@Nonnull
public Optional<ServiceType> optionalDeclService()
```
    Returns:
    
    Optional field value
  - hasDeclConst
```
public boolean hasDeclConst()
```
  - getDeclConst
```
public ConstType getDeclConst()
```
    Returns:
    
    The field value
  - optionalDeclConst
```
@Nonnull
public Optional<ConstType> optionalDeclConst()
```
    Returns:
    
    Optional field value
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface PMessage<Declaration,Declaration._Field>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface PMessage<Declaration,Declaration._Field>
  - unionFieldIsSet
```
public boolean unionFieldIsSet()
```
    Specified by:
    
    unionFieldIsSet in interface PUnion<Declaration,Declaration._Field>
  - unionField
```
@Nonnull
public Declaration._Field unionField()
```
    Specified by:
    
    unionField in interface PUnion<Declaration,Declaration._Field>
  - 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 PMessage<Declaration,Declaration._Field>
    
    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 BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public Declaration._Builder mutate()
```
    Specified by:
    
    mutate in interface PMessage<Declaration,Declaration._Field>
  - provider
```
@Nonnull
public static PUnionDescriptorProvider<Declaration,Declaration._Field> provider()
```
  - descriptor
```
@Nonnull
public PUnionDescriptor<Declaration,Declaration._Field> descriptor()
```
    Specified by:
    
    descriptor in interface PMessage<Declaration,Declaration._Field>
    
    Specified by:
    
    descriptor in interface PValue<Declaration>
  - builder
```
public static Declaration._Builder builder()
```
    Make a 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

Field Detail

kDescriptor

Method Detail

withDeclEnum

withDeclEnum

withDeclTypedef

withDeclTypedef

withDeclStruct

withDeclStruct

withDeclService

withDeclService

withDeclConst

withDeclConst

hasDeclEnum

getDeclEnum

optionalDeclEnum

hasDeclTypedef

getDeclTypedef

optionalDeclTypedef

hasDeclStruct

getDeclStruct

optionalDeclStruct

hasDeclService

getDeclService

optionalDeclService

hasDeclConst

getDeclConst

optionalDeclConst

has

get

unionFieldIsSet

unionField

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder