io.protobufx.protoc.gen.spring.generator

Class EnumDescriptor

java.lang.Object

io.protobufx.protoc.gen.spring.generator.AbstractDescriptor

io.protobufx.protoc.gen.spring.generator.EnumDescriptor

@Immutable
public class EnumDescriptor
extends AbstractDescriptor

A wrapper around DescriptorProtos.EnumDescriptorProto with additional information.

Field Summary

Fields inherited from class io.protobufx.protoc.gen.spring.generator.AbstractDescriptor

javaPkgName, name, outerClass, protoPkgName, registry

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment() Get the comment on this enum.
java.lang.String	getValueComment(java.lang.String valueName) Get the comment on a particular value of the enum.
java.util.Map<java.lang.String,java.lang.Integer>	getValues() Get the name-value pairs for possible values of the enum.

Methods inherited from class io.protobufx.protoc.gen.spring.generator.AbstractDescriptor

getJavaPkgName, getName, getNameWithinOuterClass, getProtoPkgName, getQualifiedName, getQualifiedOriginalName, getQualifiedProtoName

Methods inherited from class java.lang.Object

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

Method Detail

getComment

@Nonnull
public java.lang.String getComment()

Get the comment on this enum. // This is super important :this comment enum TestEnum { ... }

Returns:

The comment.

getValueComment

@Nonnull
public java.lang.String getValueComment(@Nonnull
                                                 java.lang.String valueName)

Get the comment on a particular value of the enum. enum TestEnum { // You want this value :this comment GOOD = 1; // You don't want this one :or this one BAD = 2; }

Parameters:

valueName - The name of the value.

Returns:

The comment, or an empty string.

getValues

@Nonnull
public java.util.Map<java.lang.String,java.lang.Integer> getValues()

Get the name-value pairs for possible values of the enum. enum TestEnum { GOOD = 1; BAD = 2; } Should return {GOOD:1, BAD:2}

Returns:

The map from value name to value index.