net.morimekta.providence.model

Interface Decl

All Known Subinterfaces:

ConstType_OrBuilder, Decl._Builder, EnumType_OrBuilder, EnumValue_OrBuilder, FieldType_OrBuilder, FunctionType_OrBuilder, MessageType_OrBuilder, ServiceType_OrBuilder, TypedefType_OrBuilder

All Known Implementing Classes:

ConstType, ConstType._Builder, Declaration, EnumType, EnumType._Builder, EnumValue, EnumValue._Builder, FieldType, FieldType._Builder, FunctionType, FunctionType._Builder, MessageType, MessageType._Builder, ServiceType, ServiceType._Builder, TypedefType, TypedefType._Builder

@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
public interface Decl

Base declaration type. All declarations have these fields.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Decl._Builder
static class	Decl._Field

Field Summary

Fields

Modifier and Type	Field and Description
static net.morimekta.providence.descriptor.PInterfaceDescriptor<?>	kDescriptor

Method Summary

Modifier and Type	Method and Description
String	getDocumentation() Documentation for the specific declaration.
String	getName() Name of the type, constant or service.
boolean	hasDocumentation()
boolean	hasName()
Optional<String>	optionalDocumentation() Documentation for the specific declaration.

Field Detail

kDescriptor

static final net.morimekta.providence.descriptor.PInterfaceDescriptor<?> kDescriptor

Method Detail

getDocumentation

String getDocumentation()

Documentation for the specific declaration.

Returns:

The documentation value.

optionalDocumentation

@Nonnull
Optional<String> optionalDocumentation()

Documentation for the specific declaration.

Returns:

Optional documentation value.

hasDocumentation

boolean hasDocumentation()

Returns:

If documentation is present.

getName

@Nonnull
String getName()

Name of the type, constant or service.

Returns:

The name value.

hasName

boolean hasName()

Returns:

If name is present.