java.lang.Object
- de.haumacher.msgbuf.data.AbstractDataObject
- - de.haumacher.msgbuf.generator.ast.WithOptions
  - - de.haumacher.msgbuf.generator.ast.DefinitionBase
    - - de.haumacher.msgbuf.generator.ast.Definition
      - de.haumacher.msgbuf.generator.ast.MessageDef

All Implemented Interfaces:

DataObject, ReflectiveDataObject, MessageDefOperations, Observable
```
public class MessageDef
extends Definition
implements MessageDefOperations
```
Definition of a data class.

Nested Class Summary
- Nested classes/interfaces inherited from class de.haumacher.msgbuf.generator.ast.Definition
  Definition.Visitor<R,A>
- Nested classes/interfaces inherited from class de.haumacher.msgbuf.generator.ast.WithOptions
  WithOptions.TypeKind

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ABSTRACT__PROP`
`static String`	`DEFINITIONS__PROP`
`static String`	`EXTENDED_DEF__PROP`
`static String`	`EXTENDS__PROP`
`static String`	`FIELDS__PROP`
`static String`	`ID__PROP`
`static String`	`MESSAGE_DEF__TYPE`	Identifier for the `MessageDef` type in JSON format.
`static String`	`SPECIALIZATIONS__PROP`

Fields inherited from class de.haumacher.msgbuf.generator.ast.Definition
FILE__PROP, NAME__PROP, OUTER__PROP

Fields inherited from class de.haumacher.msgbuf.generator.ast.DefinitionBase
COMMENT__PROP

Fields inherited from class de.haumacher.msgbuf.generator.ast.WithOptions
_listener, OPTIONS__PROP

Constructor Summary

Constructors
Modifier Constructor Description

protected MessageDef()
Creates a MessageDef instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageDef`	`addDefinition(Definition value)`	Adds a value to the `getDefinitions()` list.
`MessageDef`	`addField(Field value)`	Adds a value to the `getFields()` list.
`MessageDef`	`addSpecialization(MessageDef value)`	Adds a value to the `getSpecializations()` list.
`static MessageDef`	`create()`	Creates a `MessageDef` instance.
`Object`	`get(String field)`
`List<Definition>`	`getDefinitions()`	Ohter `Definition`s that are local to this data class.
`MessageDef`	`getExtendedDef()`	Reference to the `data class definition` that is referenced by the `getExtends()` clause.
`QName`	`getExtends()`	Optional reference to another `MessageDef` whoes fields are inherited.
`List<Field>`	`getFields()`	All `Field`s locally defined in this data class.
`int`	`getId()`	The ID used for distinguishing an instance of this type from instances of other types in the same polymorphic hierarchy.
`List<MessageDef>`	`getSpecializations()`	All `data classes` that inherit from this data class.
`boolean`	`hasExtendedDef()`	Checks, whether `getExtendedDef()` has a value.
`boolean`	`hasExtends()`	Checks, whether `getExtends()` has a value.
`protected void`	`internalAddDefinition(Definition value)`	Implementation of `addDefinition(de.haumacher.msgbuf.generator.ast.Definition)` without chain call utility.
`protected void`	`internalAddField(Field value)`	Implementation of `addField(de.haumacher.msgbuf.generator.ast.Field)` without chain call utility.
`protected void`	`internalAddSpecialization(MessageDef value)`	Implementation of `addSpecialization(de.haumacher.msgbuf.generator.ast.MessageDef)` without chain call utility.
`protected void`	`internalSetAbstract(boolean value)`	Internal setter for `isAbstract()` without chain call utility.
`protected void`	`internalSetDefinitions(List<? extends Definition> value)`	Internal setter for `getDefinitions()` without chain call utility.
`protected void`	`internalSetExtendedDef(MessageDef value)`	Internal setter for `getExtendedDef()` without chain call utility.
`protected void`	`internalSetExtends(QName value)`	Internal setter for `getExtends()` without chain call utility.
`protected void`	`internalSetFields(List<? extends Field> value)`	Internal setter for `getFields()` without chain call utility.
`protected void`	`internalSetId(int value)`	Internal setter for `getId()` without chain call utility.
`protected void`	`internalSetSpecializations(List<? extends MessageDef> value)`	Internal setter for `getSpecializations()` without chain call utility.
`boolean`	`isAbstract()`	Whether this class only serves as super type for other data classes.
`String`	`jsonType()`
`WithOptions.TypeKind`	`kind()`	The type code of this instance.
`List<String>`	`properties()`
`MessageDef`	`putOption(String key, Option value)`	Adds a key value pair to the `WithOptions.getOptions()` map.
`protected void`	`readField(JsonReader in, String field)`
`static MessageDef`	`readMessageDef(JsonReader in)`	Reads a new instance from the given reader.
`void`	`removeDefinition(Definition value)`	Removes a value from the `getDefinitions()` list.
`void`	`removeField(Field value)`	Removes a value from the `getFields()` list.
`void`	`removeSpecialization(MessageDef value)`	Removes a value from the `getSpecializations()` list.
`MessageDef`	`self()`
`void`	`set(String field, Object value)`
`MessageDef`	`setAbstract(boolean value)`
`MessageDef`	`setComment(String value)`
`MessageDef`	`setDefinitions(List<? extends Definition> value)`
`MessageDef`	`setExtendedDef(MessageDef value)`
`MessageDef`	`setExtends(QName value)`
`MessageDef`	`setFields(List<? extends Field> value)`
`MessageDef`	`setFile(DefinitionFile value)`
`MessageDef`	`setId(int value)`
`MessageDef`	`setName(String value)`
`MessageDef`	`setOptions(Map<String,Option> value)`
`MessageDef`	`setOuter(MessageDef value)`
`MessageDef`	`setSpecializations(List<? extends MessageDef> value)`
`<R,A> R`	`visit(Definition.Visitor<R,A> v, A arg)`	Accepts the given visitor.
`protected void`	`writeFields(JsonWriter out)`

Methods inherited from class de.haumacher.msgbuf.generator.ast.Definition
getFile, getName, getOuter, hasFile, hasOuter, internalSetFile, internalSetName, internalSetOuter, readDefinition, visit

Methods inherited from class de.haumacher.msgbuf.generator.ast.DefinitionBase
getComment, internalSetComment, readDefinitionBase, visit

Methods inherited from class de.haumacher.msgbuf.generator.ast.WithOptions
getOptions, internalPutOption, internalRegisterListener, internalSetOptions, internalUnregisterListener, readWithOptions, registerListener, removeOption, unregisterListener, writeTo

Methods inherited from class de.haumacher.msgbuf.data.AbstractDataObject
readContent, readFields, toString, writeContent

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

Methods inherited from interface de.haumacher.msgbuf.generator.MessageDefOperations
container

Methods inherited from interface de.haumacher.msgbuf.data.ReflectiveDataObject
transientProperties

- Field Detail
  - MESSAGE_DEF__TYPE
```
public static final String MESSAGE_DEF__TYPE
```
    Identifier for the MessageDef type in JSON format.
    
    See Also:
    
    Constant Field Values
  - ABSTRACT__PROP
```
public static final String ABSTRACT__PROP
```
    See Also:
    
    isAbstract(), Constant Field Values
  - EXTENDS__PROP
```
public static final String EXTENDS__PROP
```
    See Also:
    
    getExtends(), Constant Field Values
  - DEFINITIONS__PROP
```
public static final String DEFINITIONS__PROP
```
    See Also:
    
    getDefinitions(), Constant Field Values
  - FIELDS__PROP
```
public static final String FIELDS__PROP
```
    See Also:
    
    getFields(), Constant Field Values
  - SPECIALIZATIONS__PROP
```
public static final String SPECIALIZATIONS__PROP
```
    See Also:
    
    getSpecializations(), Constant Field Values
  - EXTENDED_DEF__PROP
```
public static final String EXTENDED_DEF__PROP
```
    See Also:
    
    getExtendedDef(), Constant Field Values
  - ID__PROP
```
public static final String ID__PROP
```
    See Also:
    
    getId(), Constant Field Values
- Constructor Detail
  - MessageDef
```
protected MessageDef()
```
    Creates a MessageDef instance.
    
    See Also:
    
    create()
- Method Detail
  - create
```
public static MessageDef create()
```
    Creates a MessageDef instance.
  - kind
```
public WithOptions.TypeKind kind()
```
    Description copied from class: WithOptions
    
    The type code of this instance.
    
    Specified by:
    
    kind in class WithOptions
  - isAbstract
```
public final boolean isAbstract()
```
    Whether this class only serves as super type for other data classes.
  - setAbstract
```
public MessageDef setAbstract(boolean value)
```
    See Also:
    
    isAbstract()
  - internalSetAbstract
```
protected final void internalSetAbstract(boolean value)
```
    Internal setter for isAbstract() without chain call utility.
  - getExtends
```
public final QName getExtends()
```
    Optional reference to another MessageDef whoes fields are inherited.
  - setExtends
```
public MessageDef setExtends(QName value)
```
    See Also:
    
    getExtends()
  - internalSetExtends
```
protected final void internalSetExtends(QName value)
```
    Internal setter for getExtends() without chain call utility.
  - hasExtends
```
public final boolean hasExtends()
```
    Checks, whether getExtends() has a value.
  - getDefinitions
```
public final List<Definition> getDefinitions()
```
    Ohter Definitions that are local to this data class.
  - setDefinitions
```
public MessageDef setDefinitions(List<? extends Definition> value)
```
    See Also:
    
    getDefinitions()
  - internalSetDefinitions
```
protected final void internalSetDefinitions(List<? extends Definition> value)
```
    Internal setter for getDefinitions() without chain call utility.
  - addDefinition
```
public MessageDef addDefinition(Definition value)
```
    Adds a value to the getDefinitions() list.
  - internalAddDefinition
```
protected final void internalAddDefinition(Definition value)
```
    Implementation of addDefinition(de.haumacher.msgbuf.generator.ast.Definition) without chain call utility.
  - removeDefinition
```
public final void removeDefinition(Definition value)
```
    Removes a value from the getDefinitions() list.
  - getFields
```
public final List<Field> getFields()
```
    All Fields locally defined in this data class.
    This list does not contain Fields that are inherited from other data classes.
    
    See Also:
    
    getExtends()
  - setFields
```
public MessageDef setFields(List<? extends Field> value)
```
    See Also:
    
    getFields()
  - internalSetFields
```
protected final void internalSetFields(List<? extends Field> value)
```
    Internal setter for getFields() without chain call utility.
  - addField
```
public MessageDef addField(Field value)
```
    Adds a value to the getFields() list.
  - internalAddField
```
protected final void internalAddField(Field value)
```
    Implementation of addField(de.haumacher.msgbuf.generator.ast.Field) without chain call utility.
  - removeField
```
public final void removeField(Field value)
```
    Removes a value from the getFields() list.
  - getSpecializations
```
public final List<MessageDef> getSpecializations()
```
    All data classes that inherit from this data class.
  - setSpecializations
```
public MessageDef setSpecializations(List<? extends MessageDef> value)
```
    See Also:
    
    getSpecializations()
  - internalSetSpecializations
```
protected final void internalSetSpecializations(List<? extends MessageDef> value)
```
    Internal setter for getSpecializations() without chain call utility.
  - addSpecialization
```
public MessageDef addSpecialization(MessageDef value)
```
    Adds a value to the getSpecializations() list.
  - internalAddSpecialization
```
protected final void internalAddSpecialization(MessageDef value)
```
    Implementation of addSpecialization(de.haumacher.msgbuf.generator.ast.MessageDef) without chain call utility.
  - removeSpecialization
```
public final void removeSpecialization(MessageDef value)
```
    Removes a value from the getSpecializations() list.
  - getExtendedDef
```
public final MessageDef getExtendedDef()
```
    Reference to the data class definition that is referenced by the getExtends() clause.
  - setExtendedDef
```
public MessageDef setExtendedDef(MessageDef value)
```
    See Also:
    
    getExtendedDef()
  - internalSetExtendedDef
```
protected final void internalSetExtendedDef(MessageDef value)
```
    Internal setter for getExtendedDef() without chain call utility.
  - hasExtendedDef
```
public final boolean hasExtendedDef()
```
    Checks, whether getExtendedDef() has a value.
  - getId
```
public final int getId()
```
    The ID used for distinguishing an instance of this type from instances of other types in the same polymorphic hierarchy.
  - setId
```
public MessageDef setId(int value)
```
    See Also:
    
    getId()
  - internalSetId
```
protected final void internalSetId(int value)
```
    Internal setter for getId() without chain call utility.
  - setName
```
public MessageDef setName(String value)
```
    Overrides:
    
    setName in class Definition
    
    See Also:
    
    Definition.getName()
  - setFile
```
public MessageDef setFile(DefinitionFile value)
```
    Overrides:
    
    setFile in class Definition
    
    See Also:
    
    Definition.getFile()
  - setOuter
```
public MessageDef setOuter(MessageDef value)
```
    Overrides:
    
    setOuter in class Definition
    
    See Also:
    
    Definition.getOuter()
  - setComment
```
public MessageDef setComment(String value)
```
    Overrides:
    
    setComment in class Definition
    
    See Also:
    
    DefinitionBase.getComment()
  - setOptions
```
public MessageDef setOptions(Map<String,Option> value)
```
    Overrides:
    
    setOptions in class Definition
    
    See Also:
    
    WithOptions.getOptions()
  - putOption
```
public MessageDef putOption(String key,
                            Option value)
```
    Description copied from class: WithOptions
    
    Adds a key value pair to the WithOptions.getOptions() map.
    
    Overrides:
    
    putOption in class Definition
  - jsonType
```
public String jsonType()
```
    Specified by:
    
    jsonType in interface ReflectiveDataObject
  - properties
```
public List<String> properties()
```
    Specified by:
    
    properties in interface ReflectiveDataObject
    
    Overrides:
    
    properties in class Definition
  - get
```
public Object get(String field)
```
    Specified by:
    
    get in interface ReflectiveDataObject
    
    Overrides:
    
    get in class Definition
  - set
```
public void set(String field,
                Object value)
```
    Specified by:
    
    set in interface ReflectiveDataObject
    
    Overrides:
    
    set in class Definition
  - readMessageDef
```
public static MessageDef readMessageDef(JsonReader in)
                                 throws IOException
```
    Reads a new instance from the given reader.
    
    Throws:
    
    IOException
  - writeFields
```
protected void writeFields(JsonWriter out)
                    throws IOException
```
    Overrides:
    
    writeFields in class Definition
    
    Throws:
    
    IOException
  - readField
```
protected void readField(JsonReader in,
                         String field)
                  throws IOException
```
    Overrides:
    
    readField in class Definition
    
    Throws:
    
    IOException
  - self
```
public MessageDef self()
```
    Specified by:
    
    self in interface MessageDefOperations
  - visit
```
public <R,A> R visit(Definition.Visitor<R,A> v,
                           A arg)
```
    Description copied from class: Definition
    
    Accepts the given visitor.
    
    Specified by:
    
    visit in class Definition

Class MessageDef

Nested Class Summary

Nested classes/interfaces inherited from class de.haumacher.msgbuf.generator.ast.Definition

Nested classes/interfaces inherited from class de.haumacher.msgbuf.generator.ast.WithOptions

Field Summary

Fields inherited from class de.haumacher.msgbuf.generator.ast.Definition

Fields inherited from class de.haumacher.msgbuf.generator.ast.DefinitionBase

Fields inherited from class de.haumacher.msgbuf.generator.ast.WithOptions

Constructor Summary

Method Summary

Methods inherited from class de.haumacher.msgbuf.generator.ast.Definition

Methods inherited from class de.haumacher.msgbuf.generator.ast.DefinitionBase

Methods inherited from class de.haumacher.msgbuf.generator.ast.WithOptions

Methods inherited from class de.haumacher.msgbuf.data.AbstractDataObject

Methods inherited from class java.lang.Object

Methods inherited from interface de.haumacher.msgbuf.generator.MessageDefOperations

Methods inherited from interface de.haumacher.msgbuf.data.ReflectiveDataObject

Field Detail

MESSAGE_DEF__TYPE

ABSTRACT__PROP

EXTENDS__PROP

DEFINITIONS__PROP

FIELDS__PROP

SPECIALIZATIONS__PROP

EXTENDED_DEF__PROP

ID__PROP

Constructor Detail

MessageDef

Method Detail

create

kind

isAbstract

setAbstract

internalSetAbstract

getExtends

setExtends

internalSetExtends

hasExtends

getDefinitions

setDefinitions

internalSetDefinitions

addDefinition

internalAddDefinition

removeDefinition

getFields

setFields

internalSetFields

addField

internalAddField

removeField

getSpecializations

setSpecializations

internalSetSpecializations

addSpecialization

internalAddSpecialization

removeSpecialization

getExtendedDef

setExtendedDef

internalSetExtendedDef

hasExtendedDef

getId

setId

internalSetId

setName

setFile

setOuter

setComment

setOptions

putOption

jsonType

properties

get

set

readMessageDef

writeFields

readField

self

visit