net.morimekta.providence.descriptor

Class PDeclaredDescriptor<T>

java.lang.Object

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

All Implemented Interfaces:

PDescriptor<T>

Direct Known Subclasses:

PEnumDescriptor, PStructDescriptor

public abstract class PDeclaredDescriptor<T>
extends Object
implements PDescriptor<T>

Descriptor for a declared type. A declared type is a value type that is derived from a thrift definition.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PDeclaredDescriptor(String comment, String packageName, String name)

Method Summary

Modifier and Type	Method and Description
abstract PBuilderFactory<T>	factory() Get the builder for the given declared type.
String	getComment() The type comment is the last block of comment written before the type declaration.
String	getName() The name of the type is the Identifier string from the IDL.
String	getPackageName() The package name is derived form the .thrift file name that is parsed or if read from serialized format is explicit.
String	getQualifiedName(String packageName) This will return the qualifying name of the type given package context.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.morimekta.providence.descriptor.PDescriptor

getType

Constructor Detail

PDeclaredDescriptor

protected PDeclaredDescriptor(String comment,
                              String packageName,
                              String name)

Method Detail

getComment

public final String getComment()

The type comment is the last block of comment written before the type declaration. Comments on the same line, after the declaration is ignored.

Returns:

The comment string containing all formatting (not including the comment delimiter and the leading space.

getPackageName

public final String getPackageName()

Description copied from interface: PDescriptor

The package name is derived form the .thrift file name that is parsed or if read from serialized format is explicit. Note that there may be package name conflicts globally.

Specified by:

getPackageName in interface PDescriptor<T>

Returns:

The package of the type. If empty the type is not in any namespace.

getName

public final String getName()

Description copied from interface: PDescriptor

The name of the type is the Identifier string from the IDL.

Specified by:

getName in interface PDescriptor<T>

Returns:

The name of the type. Not including package.

getQualifiedName

public final String getQualifiedName(String packageName)

Description copied from interface: PDescriptor

This will return the qualifying name of the type given package context.

Specified by:

getQualifiedName in interface PDescriptor<T>

Returns:

The name of the type. Including package if not matching with packageName.

toString

public String toString()

Overrides:

toString in class Object

factory

public abstract PBuilderFactory<T> factory()

Get the builder for the given declared type.

Returns:

The type specific builder provider.