ProgramMeta (Providence Generator : Common 2.6.1 API)

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

All Implemented Interfaces:

Serializable, Comparable<ProgramMeta>, ProgramMeta_OrBuilder, net.morimekta.providence.PMessage<ProgramMeta>, net.morimekta.providence.PMessageOrBuilder<ProgramMeta>, net.morimekta.providence.PValue<ProgramMeta>, net.morimekta.providence.serializer.binary.BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
 @Immutable
public class ProgramMeta
extends Object
implements ProgramMeta_OrBuilder, net.morimekta.providence.PMessage<ProgramMeta>, Comparable<ProgramMeta>, Serializable, net.morimekta.providence.serializer.binary.BinaryWriter
```
A meta object describing a parsed program file. This may include the included programs as their own meta file. The lines of the original program .thrift file is also included.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProgramMeta._Builder
A meta object describing a parsed program file.

static class ProgramMeta._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProgramMeta._Builder` A meta object describing a parsed program file.
`static class`	`ProgramMeta._Field`

Field Summary

Fields
Modifier and Type Field and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static ProgramMeta._Builder`	`builder()` Make a `p_model.ProgramMeta` builder.
`int`	`compareTo(ProgramMeta other)`
`net.morimekta.providence.descriptor.PStructDescriptor<ProgramMeta>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`List<String>`	`getFileLines()` The lines of the program file
`String`	`getFilePath()` Full absolute path to the file.
`Map<String,ProgramMeta>`	`getIncludes()` Map of program name to meta of included programs
`ProgramType`	`getProgram()` The program type definition
`boolean`	`has(int key)`
`boolean`	`hasFileLines()`
`boolean`	`hasFilePath()`
`int`	`hashCode()`
`boolean`	`hasIncludes()`
`boolean`	`hasProgram()`
`ProgramMeta._Builder`	`mutate()`
`int`	`numFileLines()`
`int`	`numIncludes()`
`Optional<List<String>>`	`optionalFileLines()` The lines of the program file
`Optional<String>`	`optionalFilePath()` Full absolute path to the file.
`Optional<Map<String,ProgramMeta>>`	`optionalIncludes()` Map of program name to meta of included programs
`Optional<ProgramType>`	`optionalProgram()` The program type definition
`static net.morimekta.providence.descriptor.PStructDescriptorProvider<ProgramMeta>`	`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<ProgramMeta> kDescriptor
```
- Method Detail
  - hasFilePath
```
public boolean hasFilePath()
```
    Specified by:
    
    hasFilePath in interface ProgramMeta_OrBuilder
    
    Returns:
    
    If file_path is present.
  - getFilePath
```
public String getFilePath()
```
    Full absolute path to the file.
    
    Specified by:
    
    getFilePath in interface ProgramMeta_OrBuilder
    
    Returns:
    
    The file_path value
  - optionalFilePath
```
@Nonnull
public Optional<String> optionalFilePath()
```
    Full absolute path to the file.
    
    Specified by:
    
    optionalFilePath in interface ProgramMeta_OrBuilder
    
    Returns:
    
    Optional of the file_path field value.
  - numFileLines
```
public int numFileLines()
```
    Specified by:
    
    numFileLines in interface ProgramMeta_OrBuilder
    
    Returns:
    
    Number of entries in file_lines.
  - hasFileLines
```
public boolean hasFileLines()
```
    Specified by:
    
    hasFileLines in interface ProgramMeta_OrBuilder
    
    Returns:
    
    If file_lines is present.
  - getFileLines
```
public List<String> getFileLines()
```
    The lines of the program file
    
    Specified by:
    
    getFileLines in interface ProgramMeta_OrBuilder
    
    Returns:
    
    The file_lines value
  - optionalFileLines
```
@Nonnull
public Optional<List<String>> optionalFileLines()
```
    The lines of the program file
    
    Specified by:
    
    optionalFileLines in interface ProgramMeta_OrBuilder
    
    Returns:
    
    Optional of the file_lines field value.
  - hasProgram
```
public boolean hasProgram()
```
    Specified by:
    
    hasProgram in interface ProgramMeta_OrBuilder
    
    Returns:
    
    If program is present.
  - getProgram
```
public ProgramType getProgram()
```
    The program type definition
    
    Specified by:
    
    getProgram in interface ProgramMeta_OrBuilder
    
    Returns:
    
    The program value
  - optionalProgram
```
@Nonnull
public Optional<ProgramType> optionalProgram()
```
    The program type definition
    
    Specified by:
    
    optionalProgram in interface ProgramMeta_OrBuilder
    
    Returns:
    
    Optional of the program field value.
  - numIncludes
```
public int numIncludes()
```
    Specified by:
    
    numIncludes in interface ProgramMeta_OrBuilder
    
    Returns:
    
    Number of entries in includes.
  - hasIncludes
```
public boolean hasIncludes()
```
    Specified by:
    
    hasIncludes in interface ProgramMeta_OrBuilder
    
    Returns:
    
    If includes is present.
  - getIncludes
```
public Map<String,ProgramMeta> getIncludes()
```
    Map of program name to meta of included programs
    
    Specified by:
    
    getIncludes in interface ProgramMeta_OrBuilder
    
    Returns:
    
    The includes value
  - optionalIncludes
```
@Nonnull
public Optional<Map<String,ProgramMeta>> optionalIncludes()
```
    Map of program name to meta of included programs
    
    Specified by:
    
    optionalIncludes in interface ProgramMeta_OrBuilder
    
    Returns:
    
    Optional of the includes field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<ProgramMeta>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<ProgramMeta>
  - 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<ProgramMeta>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(ProgramMeta other)
```
    Specified by:
    
    compareTo in interface Comparable<ProgramMeta>
  - 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 ProgramMeta._Builder mutate()
```
    Specified by:
    
    mutate in interface net.morimekta.providence.PMessage<ProgramMeta>
  - provider
```
@Nonnull
public static net.morimekta.providence.descriptor.PStructDescriptorProvider<ProgramMeta> provider()
```
  - descriptor
```
@Nonnull
public net.morimekta.providence.descriptor.PStructDescriptor<ProgramMeta> descriptor()
```
    Specified by:
    
    descriptor in interface net.morimekta.providence.PMessageOrBuilder<ProgramMeta>
    
    Specified by:
    
    descriptor in interface net.morimekta.providence.PValue<ProgramMeta>
  - builder
```
public static ProgramMeta._Builder builder()
```
    Make a p_model.ProgramMeta builder.
    
    Returns:
    
    The builder instance.

Class ProgramMeta

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

hasFilePath

getFilePath

optionalFilePath

numFileLines

hasFileLines

getFileLines

optionalFileLines

hasProgram

getProgram

optionalProgram

numIncludes

hasIncludes

getIncludes

optionalIncludes

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder