Package io.protostuff.compiler.model

Class Enum

java.lang.Object

io.protostuff.compiler.model.AbstractElement

io.protostuff.compiler.model.AbstractDescriptor

io.protostuff.compiler.model.Enum

All Implemented Interfaces:

Descriptor, Element, FieldType, Type, UserType

public class Enum
extends AbstractDescriptor
implements UserType

Enum node of proto file.

Author:

Kostiantyn Shchepanovskyi

Field Summary

Fields

Modifier and Type	Field	Description
protected List<EnumConstant>	constants
protected String	fullyQualifiedName
protected UserTypeContainer	parent
protected Proto	proto
protected List<String>	reservedFieldNames
protected List<Range>	reservedFieldRanges

Fields inherited from class io.protostuff.compiler.model.AbstractDescriptor

name, options

Fields inherited from class io.protostuff.compiler.model.AbstractElement

comments, sourceCodeLocation

Constructor Summary

Constructors

Constructor	Description
Enum(UserTypeContainer parent)

Method Summary

Modifier and Type	Method	Description
void	addConstant(EnumConstant value)
void	addReservedFieldName(String fieldName)
void	addReservedFieldRange(Range range)
String	getCanonicalName()	Returns FieldType.getFullyQualifiedName() without leading dot.
EnumConstant	getConstant(String name)	Get enum constant by it's name.
Set<String>	getConstantNames()	Returns a list of all enum constant names.
List<EnumConstant>	getConstants()
DescriptorType	getDescriptorType()
String	getFullyQualifiedName()	Returns fully qualified name for this user type.
UserTypeContainer	getParent()
Proto	getProto()
List<String>	getReservedFieldNames()
List<Range>	getReservedFieldRanges()
boolean	isEnum()	Test if this type is enum.
boolean	isMap()	Test if this type is map.
boolean	isMessage()	Test if this type is message.
boolean	isNested()	Test if this type is nested (declared inside of other message).
boolean	isScalar()	Test if this type is scalar.
void	setConstants(List<EnumConstant> constants)
void	setFullyQualifiedName(String fullyQualifiedName)
void	setProto(Proto proto)
String	toString()

Methods inherited from class io.protostuff.compiler.model.AbstractDescriptor

getName, getOptions, setName

Methods inherited from class io.protostuff.compiler.model.AbstractElement

addComment, getCommentLines, getComments, getSourceCodeLocation, setComments, setSourceCodeLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.protostuff.compiler.model.Descriptor

getOptions

Methods inherited from interface io.protostuff.compiler.model.Element

getCommentLines, getComments, getSourceCodeLocation

Methods inherited from interface io.protostuff.compiler.model.UserType

getName, setName

Field Detail

parent

protected final UserTypeContainer parent

constants

protected List<EnumConstant> constants

proto

protected Proto proto

fullyQualifiedName

protected String fullyQualifiedName

reservedFieldRanges

protected List<Range> reservedFieldRanges

reservedFieldNames

protected List<String> reservedFieldNames

Constructor Detail

Enum

public Enum(UserTypeContainer parent)

Method Detail

getConstants

public List<EnumConstant> getConstants()

setConstants

public void setConstants(List<EnumConstant> constants)

getConstantNames

public Set<String> getConstantNames()

Returns a list of all enum constant names.

getConstant

public EnumConstant getConstant(String name)

Get enum constant by it's name.

addConstant

public void addConstant(EnumConstant value)

toString

public String toString()

Overrides:

toString in class Object

getDescriptorType

public DescriptorType getDescriptorType()

Specified by:

getDescriptorType in interface Descriptor

isScalar

public boolean isScalar()

Description copied from interface: FieldType

Test if this type is scalar.

Specified by:

isScalar in interface FieldType

isEnum

public boolean isEnum()

Description copied from interface: FieldType

Test if this type is enum.

Specified by:

isEnum in interface FieldType

isMessage

public boolean isMessage()

Description copied from interface: FieldType

Test if this type is message.

Specified by:

isMessage in interface FieldType

getProto

public Proto getProto()

Specified by:

getProto in interface UserType

setProto

public void setProto(Proto proto)

Specified by:

setProto in interface UserType

getFullyQualifiedName

public String getFullyQualifiedName()

Description copied from interface: UserType

Returns fully qualified name for this user type. It always starts with dot.

Specified by:

getFullyQualifiedName in interface FieldType

Specified by:

getFullyQualifiedName in interface Type

Specified by:

getFullyQualifiedName in interface UserType

setFullyQualifiedName

public void setFullyQualifiedName(String fullyQualifiedName)

Specified by:

setFullyQualifiedName in interface UserType

getCanonicalName

public String getCanonicalName()

Description copied from interface: FieldType

Returns FieldType.getFullyQualifiedName() without leading dot.

Specified by:

getCanonicalName in interface FieldType

Specified by:

getCanonicalName in interface Type

isMap

public boolean isMap()

Description copied from interface: FieldType

Test if this type is map.

Specified by:

isMap in interface FieldType

getParent

public UserTypeContainer getParent()

Specified by:

getParent in interface Element

Specified by:

getParent in interface UserType

isNested

public boolean isNested()

Description copied from interface: UserType

Test if this type is nested (declared inside of other message).

Specified by:

isNested in interface UserType

addReservedFieldRange

public void addReservedFieldRange(Range range)

Specified by:

addReservedFieldRange in interface UserType

addReservedFieldName

public void addReservedFieldName(String fieldName)

Specified by:

addReservedFieldName in interface UserType

getReservedFieldRanges

public List<Range> getReservedFieldRanges()

Specified by:

getReservedFieldRanges in interface UserType

getReservedFieldNames

public List<String> getReservedFieldNames()

Specified by:

getReservedFieldNames in interface UserType