Package de.haumacher.msgbuf.generator.ast

Class Definition

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

All Implemented Interfaces:

DataObject, ReflectiveDataObject, Observable

Direct Known Subclasses:

EnumDef, MessageDef

public abstract class Definition
extends DefinitionBase

Base class of a definition in a DefinitionFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Definition.Visitor<R,A>	Visitor interface for the Definition hierarchy.

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

WithOptions.TypeKind

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE__PROP
static String	NAME__PROP
static String	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	Definition()	Creates a Definition instance.

Method Summary

Modifier and Type	Method	Description
Object	get(String field)
DefinitionFile	getFile()	Reference back to the DefinitionFile that contains this definition.
String	getName()	The name of this definition.
MessageDef	getOuter()	The MessageDef that contains this inner .
boolean	hasFile()	Checks, whether getFile() has a value.
boolean	hasOuter()	Checks, whether getOuter() has a value.
protected void	internalSetFile(DefinitionFile value)	Internal setter for getFile() without chain call utility.
protected void	internalSetName(String value)	Internal setter for getName() without chain call utility.
protected void	internalSetOuter(MessageDef value)	Internal setter for getOuter() without chain call utility.
List<String>	properties()
Definition	putOption(String key, Option value)	Adds a key value pair to the WithOptions.getOptions() map.
static Definition	readDefinition(JsonReader in)	Reads a new instance from the given reader.
protected void	readField(JsonReader in, String field)
void	set(String field, Object value)
Definition	setComment(String value)
Definition	setFile(DefinitionFile value)
Definition	setName(String value)
Definition	setOptions(Map<String,Option> value)
Definition	setOuter(MessageDef value)
abstract <R,A> R	visit(Definition.Visitor<R,A> v, A arg)	Accepts the given visitor.
<R,A> R	visit(DefinitionBase.Visitor<R,A> v, A arg)	Accepts the given visitor.
protected void	writeFields(JsonWriter out)

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, kind, 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.data.ReflectiveDataObject

jsonType, transientProperties

Field Detail

NAME__PROP

public static final String NAME__PROP

See Also:

getName(), Constant Field Values

FILE__PROP

public static final String FILE__PROP

See Also:

getFile(), Constant Field Values

OUTER__PROP

public static final String OUTER__PROP

See Also:

getOuter(), Constant Field Values

Constructor Detail

Definition

protected Definition()

Creates a Definition instance.

Method Detail

getName

public final String getName()

The name of this definition.

setName

public Definition setName(String value)

See Also:

getName()

internalSetName

protected final void internalSetName(String value)

Internal setter for getName() without chain call utility.

getFile

public final DefinitionFile getFile()

Reference back to the DefinitionFile that contains this definition.

setFile

public Definition setFile(DefinitionFile value)

See Also:

getFile()

internalSetFile

protected final void internalSetFile(DefinitionFile value)

Internal setter for getFile() without chain call utility.

hasFile

public final boolean hasFile()

Checks, whether getFile() has a value.

getOuter

public final MessageDef getOuter()

The MessageDef that contains this inner .

The value is null for top-level defintions, see getFile().

setOuter

public Definition setOuter(MessageDef value)

See Also:

getOuter()

internalSetOuter

protected final void internalSetOuter(MessageDef value)

Internal setter for getOuter() without chain call utility.

hasOuter

public final boolean hasOuter()

Checks, whether getOuter() has a value.

setComment

public Definition setComment(String value)

Overrides:

setComment in class DefinitionBase

See Also:

DefinitionBase.getComment()

setOptions

public Definition setOptions(Map<String,Option> value)

Overrides:

setOptions in class DefinitionBase

See Also:

WithOptions.getOptions()

putOption

public Definition putOption(String key,
                            Option value)

Description copied from class: WithOptions

Adds a key value pair to the WithOptions.getOptions() map.

Overrides:

putOption in class DefinitionBase

properties

public List<String> properties()

Specified by:

properties in interface ReflectiveDataObject

Overrides:

properties in class DefinitionBase

get

public Object get(String field)

Specified by:

get in interface ReflectiveDataObject

Overrides:

get in class DefinitionBase

set

public void set(String field,
                Object value)

Specified by:

set in interface ReflectiveDataObject

Overrides:

set in class DefinitionBase

readDefinition

public static Definition readDefinition(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 DefinitionBase

Throws:

IOException

readField

protected void readField(JsonReader in,
                         String field)
                  throws IOException

Overrides:

readField in class DefinitionBase

Throws:

IOException

visit

public abstract <R,A> R visit(Definition.Visitor<R,A> v,
                                    A arg)

Accepts the given visitor.

visit

public final <R,A> R visit(DefinitionBase.Visitor<R,A> v,
                                 A arg)

Description copied from class: DefinitionBase

Accepts the given visitor.

Specified by:

visit in class DefinitionBase