Package net.morimekta.providence.descriptor

Interface PDescriptor

All Known Implementing Classes:

PContainer, PDeclaredDescriptor, PEnumDescriptor, PExceptionDescriptor, PInterfaceDescriptor, PList, PMap, PMessageDescriptor, PPrimitive, PService, PSet, PStructDescriptor, PUnionDescriptor

public interface PDescriptor

Descriptor interface for value type V.

Note that V is specified by type even though the PDescriptor interface has no methods requiring that type.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getDefaultValue()
java.lang.String	getName()	The name of the type is the Identifier string from the IDL.
java.lang.String	getProgramName()	The package name is derived form the .thrift file name that is parsed or if read from serialized format is explicit.
default java.lang.String	getQualifiedName()	This will return the globally qualified name of the type given the program context.
java.lang.String	getQualifiedName(java.lang.String programContext)	This will return the qualified name of the type given the program context.
PType	getType()

Method Detail

getProgramName

java.lang.String getProgramName()

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.

Returns:

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

getName

@Nonnull
java.lang.String getName()

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

Returns:

The name of the type. Not including package.

getQualifiedName

@Nonnull
java.lang.String getQualifiedName(java.lang.String programContext)

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

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.

getQualifiedName

@Nonnull
default java.lang.String getQualifiedName()

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

Returns:

The qualified name of the type, including program name.

getType

@Nonnull
PType getType()

Returns:

Get the field type.

getDefaultValue

@Nullable
java.lang.Object getDefaultValue()

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.