ProgramType (Providence Generator : Common 2.6.1 API)

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

All Implemented Interfaces:

Serializable, Comparable<ProgramType>, ProgramType_OrBuilder, net.morimekta.providence.PMessage<ProgramType>, net.morimekta.providence.PMessageOrBuilder<ProgramType>, net.morimekta.providence.PValue<ProgramType>, net.morimekta.providence.serializer.binary.BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
 @Immutable
public class ProgramType
extends Object
implements ProgramType_OrBuilder, net.morimekta.providence.PMessage<ProgramType>, Comparable<ProgramType>, Serializable, net.morimekta.providence.serializer.binary.BinaryWriter
```
<namespace>* <include>* <declataion>*

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProgramType._Builder
<namespace>* <include>* <declataion>*

static class ProgramType._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProgramType._Builder` <namespace>* <include>* <declataion>*
`static class`	`ProgramType._Field`

Field Summary

Fields
Modifier and Type Field and Description

static net.morimekta.providence.descriptor.PStructDescriptor<ProgramType> kDescriptor

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static ProgramType._Builder`	`builder()` Make a `p_model.ProgramType` builder.
`int`	`compareTo(ProgramType other)`
`net.morimekta.providence.descriptor.PStructDescriptor<ProgramType>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`List<Declaration>`	`getDecl()` List of declarations in the program file.
`String`	`getDocumentation()` Program documentation must come before the first statement of the header.
`Map<String,String>`	`getIncludes()` List of included thrift files.
`Map<String,String>`	`getNamespaces()` Map of language to laguage dependent namespace identifier.
`String`	`getProgramName()` The program name, deducted from the .thrift IDL file name.
`boolean`	`has(int key)`
`boolean`	`hasDecl()`
`boolean`	`hasDocumentation()`
`int`	`hashCode()`
`boolean`	`hasIncludes()`
`boolean`	`hasNamespaces()`
`boolean`	`hasProgramName()`
`ProgramType._Builder`	`mutate()`
`int`	`numDecl()`
`int`	`numIncludes()`
`int`	`numNamespaces()`
`Optional<List<Declaration>>`	`optionalDecl()` List of declarations in the program file.
`Optional<String>`	`optionalDocumentation()` Program documentation must come before the first statement of the header.
`Optional<Map<String,String>>`	`optionalIncludes()` List of included thrift files.
`Optional<Map<String,String>>`	`optionalNamespaces()` Map of language to laguage dependent namespace identifier.
`static net.morimekta.providence.descriptor.PStructDescriptorProvider<ProgramType>`	`provider()`
`String`	`toString()`
`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.PStructDescriptor<ProgramType> kDescriptor
```
- Method Detail
  - hasDocumentation
```
public boolean hasDocumentation()
```
    Specified by:
    
    hasDocumentation in interface ProgramType_OrBuilder
    
    Returns:
    
    If documentation is present.
  - getDocumentation
```
public String getDocumentation()
```
    Program documentation must come before the first statement of the header.
    
    Specified by:
    
    getDocumentation in interface ProgramType_OrBuilder
    
    Returns:
    
    The documentation value
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Program documentation must come before the first statement of the header.
    
    Specified by:
    
    optionalDocumentation in interface ProgramType_OrBuilder
    
    Returns:
    
    Optional of the documentation field value.
  - hasProgramName
```
public boolean hasProgramName()
```
    Specified by:
    
    hasProgramName in interface ProgramType_OrBuilder
    
    Returns:
    
    If program_name is present.
  - getProgramName
```
@Nonnull
public String getProgramName()
```
    The program name, deducted from the .thrift IDL file name.
    
    Specified by:
    
    getProgramName in interface ProgramType_OrBuilder
    
    Returns:
    
    The program_name value
  - numIncludes
```
public int numIncludes()
```
    Specified by:
    
    numIncludes in interface ProgramType_OrBuilder
    
    Returns:
    
    Number of entries in includes.
  - hasIncludes
```
public boolean hasIncludes()
```
    Specified by:
    
    hasIncludes in interface ProgramType_OrBuilder
    
    Returns:
    
    If includes is present.
  - getIncludes
```
public Map<String,String> getIncludes()
```
    List of included thrift files. Same as from the actual thrift file.
    include "<program>.thrift"
    
    Specified by:
    
    getIncludes in interface ProgramType_OrBuilder
    
    Returns:
    
    The includes value
  - optionalIncludes
```
@Nonnull
public Optional<Map<String,String>> optionalIncludes()
```
    List of included thrift files. Same as from the actual thrift file.
    include "<program>.thrift"
    
    Specified by:
    
    optionalIncludes in interface ProgramType_OrBuilder
    
    Returns:
    
    Optional of the includes field value.
  - numNamespaces
```
public int numNamespaces()
```
    Specified by:
    
    numNamespaces in interface ProgramType_OrBuilder
    
    Returns:
    
    Number of entries in namespaces.
  - hasNamespaces
```
public boolean hasNamespaces()
```
    Specified by:
    
    hasNamespaces in interface ProgramType_OrBuilder
    
    Returns:
    
    If namespaces is present.
  - getNamespaces
```
public Map<String,String> getNamespaces()
```
    Map of language to laguage dependent namespace identifier.
    namespace <key> <value>
    
    Specified by:
    
    getNamespaces in interface ProgramType_OrBuilder
    
    Returns:
    
    The namespaces value
  - optionalNamespaces
```
@Nonnull
public Optional<Map<String,String>> optionalNamespaces()
```
    Map of language to laguage dependent namespace identifier.
    namespace <key> <value>
    
    Specified by:
    
    optionalNamespaces in interface ProgramType_OrBuilder
    
    Returns:
    
    Optional of the namespaces field value.
  - numDecl
```
public int numDecl()
```
    Specified by:
    
    numDecl in interface ProgramType_OrBuilder
    
    Returns:
    
    Number of entries in decl.
  - hasDecl
```
public boolean hasDecl()
```
    Specified by:
    
    hasDecl in interface ProgramType_OrBuilder
    
    Returns:
    
    If decl is present.
  - getDecl
```
public List<Declaration> getDecl()
```
    List of declarations in the program file. Same order as in the thrift file.
    
    Specified by:
    
    getDecl in interface ProgramType_OrBuilder
    
    Returns:
    
    The decl value
  - optionalDecl
```
@Nonnull
public Optional<List<Declaration>> optionalDecl()
```
    List of declarations in the program file. Same order as in the thrift file.
    
    Specified by:
    
    optionalDecl in interface ProgramType_OrBuilder
    
    Returns:
    
    Optional of the decl field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<ProgramType>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<ProgramType>
  - 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<ProgramType>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(ProgramType other)
```
    Specified by:
    
    compareTo in interface Comparable<ProgramType>
  - 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 ProgramType._Builder mutate()
```
    Specified by:
    
    mutate in interface net.morimekta.providence.PMessage<ProgramType>
  - provider
```
@Nonnull
public static net.morimekta.providence.descriptor.PStructDescriptorProvider<ProgramType> provider()
```
  - descriptor
```
@Nonnull
public net.morimekta.providence.descriptor.PStructDescriptor<ProgramType> descriptor()
```
    Specified by:
    
    descriptor in interface net.morimekta.providence.PMessageOrBuilder<ProgramType>
    
    Specified by:
    
    descriptor in interface net.morimekta.providence.PValue<ProgramType>
  - builder
```
public static ProgramType._Builder builder()
```
    Make a p_model.ProgramType builder.
    
    Returns:
    
    The builder instance.

Class ProgramType

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

hasDocumentation

getDocumentation

optionalDocumentation

hasProgramName

getProgramName

numIncludes

hasIncludes

getIncludes

optionalIncludes

numNamespaces

hasNamespaces

getNamespaces

optionalNamespaces

numDecl

hasDecl

getDecl

optionalDecl

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder