net.morimekta.providence.descriptor

Class PDeclaredDescriptor<T>

java.lang.Object

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

All Implemented Interfaces:

Type, PDescriptor

Direct Known Subclasses:

PEnumDescriptor, PMessageDescriptor, PService

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

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 programName, String name)

Method Summary

Modifier and Type	Method and Description
T	getDefaultValue()
String	getName() The name of the type is the Identifier string from the IDL.
String	getProgramName() The package name is derived form the .thrift file name that is parsed or if read from serialized format is explicit.
String	getQualifiedName(String programContext) This will return the qualified name of the type given the program context.
String	getTypeName()
abstract boolean	isAutoType()
abstract boolean	isInnerType()
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

getQualifiedName, getType

Constructor Detail

PDeclaredDescriptor

protected PDeclaredDescriptor(@Nonnull
                              String programName,
                              @Nonnull
                              String name)

Method Detail

getTypeName

@Nonnull
public String getTypeName()

Specified by:

getTypeName in interface Type

getProgramName

@Nonnull
public final String getProgramName()

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:

getProgramName in interface PDescriptor

Returns:

The program name of the type. If empty the type is not in any named program, e.g. primitives.

getName

@Nonnull
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

Returns:

The name of the type. Not including package.

getQualifiedName

@Nonnull
public final String getQualifiedName(String programContext)

Description copied from interface: PDescriptor

This will return the qualified name of the type given the program context.

Specified by:

getQualifiedName in interface PDescriptor

Parameters:

programContext - The program which the type should be referenced from.

Returns:

The qualified name of the type. Including program if not matching with programContext.

getDefaultValue

@Nullable
public T getDefaultValue()

Specified by:

getDefaultValue in interface PDescriptor

Returns:

The default value for the type used for default and required fields. Note that some primitive types don't support null values, and will have methods returning a default value regardless of the field required value setting.

toString

public String toString()

Overrides:

toString in class Object

isInnerType

public abstract boolean isInnerType()

Returns:

Returns true if the type is an inner type. Meaning it is contained within another type or service.

isAutoType

public abstract boolean isAutoType()

Returns:

Returns true if the type is generated automatically by means of something else, e.g. request and response types for services. Or is a built in type as part of providence itself.