io.protostuff.compiler.model

Class Message

java.lang.Object

io.protostuff.compiler.model.AbstractElement

io.protostuff.compiler.model.AbstractDescriptor

io.protostuff.compiler.model.AbstractUserTypeContainer

io.protostuff.compiler.model.Message

All Implemented Interfaces:

Descriptor, Element, EnumContainer, ExtensionContainer, FieldContainer, FieldType, GroupContainer, MessageContainer, Type, UserType, UserTypeContainer

Direct Known Subclasses:

Group

public class Message
extends AbstractUserTypeContainer
implements UserType, UserTypeContainer, FieldContainer, GroupContainer

Author:

Kostiantyn Shchepanovskyi

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Range>	extensionRanges
protected List<Field>	fields
protected String	fullyQualifiedName
protected List<Group>	groups
protected List<Oneof>	oneofs
protected Proto	proto
protected List<String>	reservedFieldNames
protected List<Range>	reservedFieldRanges

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

declaredExtensions, enums, messages, parent

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 and Description
Message(UserTypeContainer parent)

Method Summary

Modifier and Type	Method and Description
void	addExtensionRange(Range range)
void	addField(Field field)
void	addGroup(Group group)
void	addOneof(Oneof oneof)
void	addReservedFieldName(String name)
void	addReservedFieldRange(Range range)
String	getCanonicalName() Returns FieldType.getFullyQualifiedName() without leading dot.
DescriptorType	getDescriptorType()
List<Range>	getExtensionRanges()
Field	getField(int tag)
Field	getField(String name)
int	getFieldCount()
List<Field>	getFields() Returns all fields in this message, including group fields and oneof fields.
String	getFullyQualifiedName() Returns fully qualified name for this user type.
List<Group>	getGroups()
String	getNamespace() Returns string prefix that is common for all children full names.
Oneof	getOneof(String name)
List<Oneof>	getOneofs()
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	isMapEntry()
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	setExtensionRanges(List<Range> extensionRanges)
void	setFields(List<Field> fields)
void	setFullyQualifiedName(String fullyQualifiedName)
void	setGroups(List<Group> groups)
void	setOneofs(List<Oneof> oneofs)
void	setProto(Proto proto)
void	setReservedFieldNames(List<String> reservedFieldNames)
void	setReservedFieldRanges(List<Range> reservedFieldRanges)
String	toString()

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

addDeclaredExtension, addEnum, addMessage, getDeclaredExtensions, getEnums, getMessages, getParent, setEnums

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.UserType

getName, getParent, setName

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.MessageContainer

addMessage, getMessage, getMessages

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

addEnum, getEnum, getEnums

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

addDeclaredExtension, getDeclaredExtensions

Field Detail

fields

protected List<Field> fields

groups

protected List<Group> groups

oneofs

protected List<Oneof> oneofs

proto

protected Proto proto

fullyQualifiedName

protected String fullyQualifiedName

extensionRanges

protected List<Range> extensionRanges

reservedFieldRanges

protected List<Range> reservedFieldRanges

reservedFieldNames

protected List<String> reservedFieldNames

Constructor Detail

Message

public Message(UserTypeContainer parent)

Method Detail

getDescriptorType

public DescriptorType getDescriptorType()

Specified by:

getDescriptorType in interface Descriptor

getFields

public List<Field> getFields()

Returns all fields in this message, including group fields and oneof fields.

Specified by:

getFields in interface FieldContainer

setFields

public void setFields(List<Field> fields)

Specified by:

setFields in interface FieldContainer

addField

public void addField(Field field)

Specified by:

addField in interface FieldContainer

getField

public Field getField(String name)

Specified by:

getField in interface FieldContainer

getField

public Field getField(int tag)

Specified by:

getField in interface FieldContainer

getOneofs

public List<Oneof> getOneofs()

setOneofs

public void setOneofs(List<Oneof> oneofs)

addOneof

public void addOneof(Oneof oneof)

getOneof

public Oneof getOneof(String name)

toString

public String toString()

Overrides:

toString in class Object

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

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

setFullyQualifiedName

public void setFullyQualifiedName(String fullyQualifiedName)

Specified by:

setFullyQualifiedName 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

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

isMap

public boolean isMap()

Description copied from interface: FieldType

Test if this type is map.

Specified by:

isMap in interface FieldType

getNamespace

public String getNamespace()

Description copied from interface: UserTypeContainer

Returns string prefix that is common for all children full names. For root container it is a dot if package is not set.

Specified by:

getNamespace in interface UserTypeContainer

getGroups

public List<Group> getGroups()

Specified by:

getGroups in interface GroupContainer

setGroups

public void setGroups(List<Group> groups)

Specified by:

setGroups in interface GroupContainer

addGroup

public void addGroup(Group group)

Specified by:

addGroup in interface GroupContainer

getExtensionRanges

public List<Range> getExtensionRanges()

setExtensionRanges

public void setExtensionRanges(List<Range> extensionRanges)

addExtensionRange

public void addExtensionRange(Range range)

getReservedFieldRanges

public List<Range> getReservedFieldRanges()

setReservedFieldRanges

public void setReservedFieldRanges(List<Range> reservedFieldRanges)

addReservedFieldRange

public void addReservedFieldRange(Range range)

getReservedFieldNames

public List<String> getReservedFieldNames()

setReservedFieldNames

public void setReservedFieldNames(List<String> reservedFieldNames)

addReservedFieldName

public void addReservedFieldName(String name)

getFieldCount

public int getFieldCount()

Specified by:

getFieldCount in interface FieldContainer

isMapEntry

public boolean isMapEntry()