net.morimekta.providence.descriptor

Class PStructDescriptor<T extends PMessage<T>,F extends PField>

java.lang.Object

net.morimekta.providence.descriptor.PDeclaredDescriptor<T>

net.morimekta.providence.descriptor.PStructDescriptor<T,F>

All Implemented Interfaces:

PDescriptor<T>

Direct Known Subclasses:

PExceptionDescriptor, PUnionDescriptor

public abstract class PStructDescriptor<T extends PMessage<T>,F extends PField>
extends PDeclaredDescriptor<T>

The definition of a thrift structure.

Constructor Summary

Constructors

Constructor and Description
PStructDescriptor(String comment, String packageName, String name, PMessageBuilderFactory<T> provider, boolean simple, boolean compactible)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
PMessageBuilderFactory<T>	factory() Get the builder for the given declared type.
abstract F	getField(int key)
abstract F	getField(String name)
abstract F[]	getFields()
PType	getType()
PMessageVariant	getVariant()
int	hashCode()
boolean	isCompactible()
boolean	isSimple()

Methods inherited from class net.morimekta.providence.descriptor.PDeclaredDescriptor

getComment, getName, getPackageName, getQualifiedName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PStructDescriptor

public PStructDescriptor(String comment,
                         String packageName,
                         String name,
                         PMessageBuilderFactory<T> provider,
                         boolean simple,
                         boolean compactible)

Method Detail

getFields

public abstract F[] getFields()

Returns:

An unmodifiable list of fields that the struct holds.

getField

public abstract F getField(String name)

Parameters:

name - Name of field to get.

Returns:

The field if present.

getField

public abstract F getField(int key)

Parameters:

key - The ID of the field to get.

Returns:

The field if present.

isCompactible

public boolean isCompactible()

Returns:

True iff the struct can be (de)serialized with compact message format.

isSimple

public boolean isSimple()

Returns:

True iff the struct is simple. A simple struct contains no containers, and no

getVariant

public PMessageVariant getVariant()

Returns:

The struct variant.

getType

public PType getType()

Returns:

Get the field type.

factory

public PMessageBuilderFactory<T> factory()

Description copied from class: PDeclaredDescriptor

Get the builder for the given declared type.

Specified by:

factory in class PDeclaredDescriptor<T extends PMessage<T>>

Returns:

The type specific builder provider.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object