net.morimekta.providence.model

Class ProgramMeta

java.lang.Object

net.morimekta.providence.model.ProgramMeta

All Implemented Interfaces:

Serializable, Comparable<ProgramMeta>, PMessage<ProgramMeta,ProgramMeta._Field>, PValue<ProgramMeta>, BinaryWriter, net.morimekta.util.Stringable

@Generated(value="providence-maven-plugin")
 @Immutable
public class ProgramMeta
extends Object
implements PMessage<ProgramMeta,ProgramMeta._Field>, Comparable<ProgramMeta>, Serializable, 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

Field Summary

Fields

Modifier and Type	Field and Description
static PStructDescriptor<ProgramMeta,ProgramMeta._Field>	kDescriptor

Method Summary

Modifier and Type	Method and Description
String	asString()
static ProgramMeta._Builder	builder() Make a pmodel.ProgramMeta builder.
int	compareTo(ProgramMeta other)
PStructDescriptor<ProgramMeta,ProgramMeta._Field>	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 PStructDescriptorProvider<ProgramMeta,ProgramMeta._Field>	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

Field Detail

kDescriptor

public static final PStructDescriptor<ProgramMeta,ProgramMeta._Field> kDescriptor

Method Detail

hasFilePath

public boolean hasFilePath()

getFilePath

public String getFilePath()

Full absolute path to the file.

Returns:

The file_path value

optionalFilePath

@Nonnull
public Optional<String> optionalFilePath()

Full absolute path to the file.

Returns:

Optional of the file_path field value.

numFileLines

public int numFileLines()

hasFileLines

public boolean hasFileLines()

getFileLines

public List<String> getFileLines()

The lines of the program file

Returns:

The file_lines value

optionalFileLines

@Nonnull
public Optional<List<String>> optionalFileLines()

The lines of the program file

Returns:

Optional of the file_lines field value.

hasProgram

public boolean hasProgram()

getProgram

public ProgramType getProgram()

The program type definition

Returns:

The program value

optionalProgram

@Nonnull
public Optional<ProgramType> optionalProgram()

The program type definition

Returns:

Optional of the program field value.

numIncludes

public int numIncludes()

hasIncludes

public boolean hasIncludes()

getIncludes

public Map<String,ProgramMeta> getIncludes()

Map of program name to meta of included programs

Returns:

The includes value

optionalIncludes

@Nonnull
public Optional<Map<String,ProgramMeta>> optionalIncludes()

Map of program name to meta of included programs

Returns:

Optional of the includes field value.

has

public boolean has(int key)

Specified by:

has in interface PMessage<ProgramMeta,ProgramMeta._Field>

get

public <T> T get(int key)

Specified by:

get in interface PMessage<ProgramMeta,ProgramMeta._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<ProgramMeta,ProgramMeta._Field>

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 BinaryWriter

Throws:

IOException

mutate

@Nonnull
public ProgramMeta._Builder mutate()

Specified by:

mutate in interface PMessage<ProgramMeta,ProgramMeta._Field>

provider

@Nonnull
public static PStructDescriptorProvider<ProgramMeta,ProgramMeta._Field> provider()

descriptor

@Nonnull
public PStructDescriptor<ProgramMeta,ProgramMeta._Field> descriptor()

Specified by:

descriptor in interface PMessage<ProgramMeta,ProgramMeta._Field>

Specified by:

descriptor in interface PValue<ProgramMeta>

builder

public static ProgramMeta._Builder builder()

Make a pmodel.ProgramMeta builder.

Returns:

The builder instance.