Message (protostuff :: parser 1.7.4 API)

java.lang.Object
- io.protostuff.parser.AnnotationContainer
- - io.protostuff.parser.Message

All Implemented Interfaces:

HasAnnotations, HasFields, HasName, HasOptions, HasProto
```
public class Message
extends AnnotationContainer
implements HasName, HasFields
```
Represents the message defined in the Proto.

Author:

David Yu

Date created:

Dec 19, 2009

Constructor Summary

Constructors
Constructor and Description

Message(String name, Message parentMessage, Proto proto)

Constructors
Constructor and Description
`Message(String name, Message parentMessage, Proto proto)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addField(Field<?> field)`
`void`	`addNestedExtension(Extension extension)`
`void`	`defineExtensionRange(int first, int last)`
`void`	`extend(Extension extension)`
`int`	`getBytesFieldCount()`
`Message`	`getDescendant(String name)`
`String`	`getEnclosingNamespace()`
`int`	`getEnumFieldCount()`
`<V> V`	`getExtraOption(String key)`
`LinkedHashMap<String,Object>`	`getExtraOptions()`
`Field<?>`	`getField(String name)`
`<T extends Field<?>> T`	`getField(String name, Class<T> typeClass)`
`int`	`getFieldCount()`
`LinkedHashMap<String,Field<?>>`	`getFieldMap()`
`List<Field<?>>`	`getFields()`
`String`	`getFullName()`
`String`	`getJavaFullName()`
`int`	`getMessageFieldCount()`
`String`	`getName()`
`EnumGroup`	`getNestedEnumGroup(String name)`
`LinkedHashMap<String,EnumGroup>`	`getNestedEnumGroupMap()`
`Collection<EnumGroup>`	`getNestedEnumGroups()`
`Collection<Extension>`	`getNestedExtensions()`
`Message`	`getNestedMessage(String name)`
`LinkedHashMap<String,Message>`	`getNestedMessageMap()`
`Collection<Message>`	`getNestedMessages()`
`Service`	`getNestedService(String name)`
`LinkedHashMap<String,Service>`	`getNestedServiceMap()`
`Collection<Service>`	`getNestedServices()`
`LinkedHashMap<String,Object>`	`getO()`
`int`	`getOptionalBytesFieldCount()`
`int`	`getOptionalEnumFieldCount()`
`int`	`getOptionalFieldCount()`
`int`	`getOptionalMessageFieldCount()`
`int`	`getOptionalStringFieldCount()`
`LinkedHashMap<String,Object>`	`getOptions()`
`Message`	`getParentMessage()`
`Proto`	`getProto()`
`String`	`getRelativeName()`
`int`	`getRepeatedBytesFieldCount()`
`int`	`getRepeatedEnumFieldCount()`
`int`	`getRepeatedFieldCount()`
`int`	`getRepeatedMessageFieldCount()`
`int`	`getRepeatedStringFieldCount()`
`int`	`getRequiredBytesFieldCount()`
`int`	`getRequiredEnumFieldCount()`
`int`	`getRequiredFieldCount()`
`int`	`getRequiredMessageFieldCount()`
`int`	`getRequiredStringFieldCount()`
`Message`	`getRootMessage()`
`int`	`getScalarFieldCount()`
`int`	`getScalarWithoutEnumFieldCount()`
`int`	`getSingularBytesFieldCount()`
`int`	`getSingularEnumFieldCount()`
`int`	`getSingularFieldCount()`
`int`	`getSingularMessageFieldCount()`
`int`	`getSingularStringFieldCount()`
`Object`	`getStandardOption(String key)`
`LinkedHashMap<String,Object>`	`getStandardOptions()`
`int`	`getStringFieldCount()`
`boolean`	`hasNestedEnumGroups()`
`boolean`	`hasNestedMessages()`
`boolean`	`isAnnotationPresentOnFields()`
`boolean`	`isByteBufferFieldPresent()`
`boolean`	`isBytesFieldPresent()`
`boolean`	`isBytesOrStringDefaultValuePresent()`
`boolean`	`isDescendant(Message other)`
`boolean`	`isExtensible()`
`boolean`	`isNested()`
`boolean`	`isRepeatedFieldPresent()`
`boolean`	`isRequiredFieldPresent()`
`boolean`	`isRequiredFieldPresentOnCurrent()`
`void`	`putExtraOption(String key, Object value)`
`void`	`putStandardOption(String key, Object value)`
`void`	`setByteBufferFieldPresent(boolean v)`
`String`	`toString()`

Methods inherited from class io.protostuff.parser.AnnotationContainer
add, addAnnotations, addDoc, err, getA, getAnnotation, getAnnotationMap, getAnnotations, getDocs, hasAnnotation, isEmptyA

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(String name,
       Message parentMessage,
       Proto proto)

Method Detail

getName
```
public String getName()
```
Specified by:

getName in interface HasName

getProto
```
public Proto getProto()
```
Specified by:

getProto in interface HasProto

getRootMessage
```
public Message getRootMessage()
```

getParentMessage
```
public Message getParentMessage()
```

isNested
```
public boolean isNested()
```

hasNestedMessages
```
public boolean hasNestedMessages()
```

hasNestedEnumGroups
```
public boolean hasNestedEnumGroups()
```

getNestedMessageMap

public LinkedHashMap<String,Message> getNestedMessageMap()

getNestedMessages

public Collection<Message> getNestedMessages()

getNestedMessage

public Message getNestedMessage(String name)

getNestedEnumGroupMap

public LinkedHashMap<String,EnumGroup> getNestedEnumGroupMap()

getNestedEnumGroups

public Collection<EnumGroup> getNestedEnumGroups()

getNestedEnumGroup

public EnumGroup getNestedEnumGroup(String name)

getNestedServiceMap

public LinkedHashMap<String,Service> getNestedServiceMap()

getNestedServices

public Collection<Service> getNestedServices()

getNestedService

public Service getNestedService(String name)

getFieldMap

public LinkedHashMap<String,Field<?>> getFieldMap()

getFields
```
public List<Field<?>> getFields()
```
Specified by:

getFields in interface HasFields

getField
```
public Field<?> getField(String name)
```
Specified by:

getField in interface HasFields

isDescendant

public boolean isDescendant(Message other)

getDescendant

public Message getDescendant(String name)

getField

public <T extends Field<?>> T getField(String name,
                              Class<T> typeClass)

addField
```
public void addField(Field<?> field)
```
Specified by:

addField in interface HasFields

defineExtensionRange

public void defineExtensionRange(int first,
                        int last)

addNestedExtension

public void addNestedExtension(Extension extension)

getNestedExtensions

public Collection<Extension> getNestedExtensions()

extend

public void extend(Extension extension)

putStandardOption

public void putStandardOption(String key,
                     Object value)

Specified by:: putStandardOption in interface HasOptions

putExtraOption

public void putExtraOption(String key,
                  Object value)

Specified by:: putExtraOption in interface HasOptions

getStandardOptions

public LinkedHashMap<String,Object> getStandardOptions()

getStandardOption

public Object getStandardOption(String key)

getExtraOptions

public LinkedHashMap<String,Object> getExtraOptions()

getExtraOption

public <V> V getExtraOption(String key)

getO

public LinkedHashMap<String,Object> getO()

getOptions
```
public LinkedHashMap<String,Object> getOptions()
```
Specified by:

getOptions in interface HasOptions

toString
```
public String toString()
```
Overrides:

toString in class Object

getEnclosingNamespace
```
public String getEnclosingNamespace()
```
Specified by:

getEnclosingNamespace in interface HasFields

getFullName
```
public String getFullName()
```

getJavaFullName
```
public String getJavaFullName()
```

getRelativeName
```
public String getRelativeName()
```

isExtensible
```
public boolean isExtensible()
```

isAnnotationPresentOnFields

public boolean isAnnotationPresentOnFields()

isRepeatedFieldPresent

public boolean isRepeatedFieldPresent()

isBytesFieldPresent
```
public boolean isBytesFieldPresent()
```

isByteBufferFieldPresent

public boolean isByteBufferFieldPresent()

setByteBufferFieldPresent

public void setByteBufferFieldPresent(boolean v)

isBytesOrStringDefaultValuePresent

public boolean isBytesOrStringDefaultValuePresent()

isRequiredFieldPresent

public boolean isRequiredFieldPresent()

isRequiredFieldPresentOnCurrent

public boolean isRequiredFieldPresentOnCurrent()

getFieldCount
```
public int getFieldCount()
```

getRequiredFieldCount
```
public int getRequiredFieldCount()
```

getRepeatedFieldCount
```
public int getRepeatedFieldCount()
```

getOptionalFieldCount
```
public int getOptionalFieldCount()
```

getSingularFieldCount
```
public int getSingularFieldCount()
```

getMessageFieldCount
```
public int getMessageFieldCount()
```

getRequiredMessageFieldCount

public int getRequiredMessageFieldCount()

getRepeatedMessageFieldCount

public int getRepeatedMessageFieldCount()

getOptionalMessageFieldCount

public int getOptionalMessageFieldCount()

getSingularMessageFieldCount

public int getSingularMessageFieldCount()

getEnumFieldCount
```
public int getEnumFieldCount()
```

getRequiredEnumFieldCount

public int getRequiredEnumFieldCount()

getRepeatedEnumFieldCount

public int getRepeatedEnumFieldCount()

getOptionalEnumFieldCount

public int getOptionalEnumFieldCount()

getSingularEnumFieldCount

public int getSingularEnumFieldCount()

getBytesFieldCount
```
public int getBytesFieldCount()
```

getRequiredBytesFieldCount

public int getRequiredBytesFieldCount()

getRepeatedBytesFieldCount

public int getRepeatedBytesFieldCount()

getOptionalBytesFieldCount

public int getOptionalBytesFieldCount()

getSingularBytesFieldCount

public int getSingularBytesFieldCount()

getStringFieldCount
```
public int getStringFieldCount()
```

getRequiredStringFieldCount

public int getRequiredStringFieldCount()

getRepeatedStringFieldCount

public int getRepeatedStringFieldCount()

getOptionalStringFieldCount

public int getOptionalStringFieldCount()

getSingularStringFieldCount

public int getSingularStringFieldCount()

getScalarFieldCount
```
public int getScalarFieldCount()
```

getScalarWithoutEnumFieldCount

public int getScalarWithoutEnumFieldCount()

Class Message

Constructor Summary

Method Summary

Methods inherited from class io.protostuff.parser.AnnotationContainer

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

getName

getProto

getRootMessage

getParentMessage

isNested

hasNestedMessages

hasNestedEnumGroups

getNestedMessageMap

getNestedMessages

getNestedMessage

getNestedEnumGroupMap

getNestedEnumGroups

getNestedEnumGroup

getNestedServiceMap

getNestedServices

getNestedService

getFieldMap

getFields

getField

isDescendant

getDescendant

getField

addField

defineExtensionRange

addNestedExtension

getNestedExtensions

extend

putStandardOption

putExtraOption

getStandardOptions

getStandardOption

getExtraOptions

getExtraOption

getO

getOptions

toString

getEnclosingNamespace

getFullName

getJavaFullName

getRelativeName

isExtensible

isAnnotationPresentOnFields

isRepeatedFieldPresent

isBytesFieldPresent

isByteBufferFieldPresent

setByteBufferFieldPresent

isBytesOrStringDefaultValuePresent

isRequiredFieldPresent

isRequiredFieldPresentOnCurrent

getFieldCount

getRequiredFieldCount

getRepeatedFieldCount

getOptionalFieldCount

getSingularFieldCount

getMessageFieldCount

getRequiredMessageFieldCount

getRepeatedMessageFieldCount

getOptionalMessageFieldCount

getSingularMessageFieldCount

getEnumFieldCount

getRequiredEnumFieldCount

getRepeatedEnumFieldCount

getOptionalEnumFieldCount

getSingularEnumFieldCount

getBytesFieldCount

getRequiredBytesFieldCount

getRepeatedBytesFieldCount

getOptionalBytesFieldCount

getSingularBytesFieldCount

getStringFieldCount

getRequiredStringFieldCount

getRepeatedStringFieldCount