Package de.haumacher.msgbuf.generator.ast

Class Field

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

de.haumacher.msgbuf.generator.ast.Field

All Implemented Interfaces:

DataObject, ReflectiveDataObject, FieldOperations, Observable

public class Field
extends Part
implements FieldOperations

A field definition of a MessageDef.

Nested Class Summary

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

Part.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 final String	FIELD__TYPE	Identifier for the Field type in JSON format.
static final String	REPEATED__PROP
static final String	TRANSIENT__PROP
static final String	TYPE__PROP

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

INDEX__PROP, NAME__PROP, OWNER__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	Field()	Creates a Field instance.

Method Summary

Modifier and Type	Method	Description
static Field	create()	Creates a Field instance.
Object	get(String field)
final Type	getType()	The type of values that can be stored in this field.
final boolean	hasType()	Checks, whether getType() has a value.
protected final void	internalSetRepeated(boolean value)	Internal setter for isRepeated() without chain call utility.
protected final void	internalSetTransient(boolean value)	Internal setter for isTransient() without chain call utility.
protected final void	internalSetType(Type value)	Internal setter for getType() without chain call utility.
final boolean	isRepeated()	Whether this field contains multiple values of its getType().
final boolean	isTransient()	Whether this field is not serialized when a message is created.
String	jsonType()
WithOptions.TypeKind	kind()	The type code of this instance.
List<String>	properties()
Field	putOption(String key, Option value)	Adds a key value pair to the WithOptions.getOptions() map.
static Field	readField(JsonReader in)	Reads a new instance from the given reader.
protected void	readField(JsonReader in, String field)
Field	self()	The implementation.
void	set(String field, Object value)
Field	setComment(String value)
Field	setIndex(int value)
Field	setName(String value)
Field	setOptions(Map<String,Option> value)
Field	setOwner(Definition value)
Field	setRepeated(boolean value)
Field	setTransient(boolean value)
Field	setType(Type value)
<R, A> R	visit(Part.Visitor<R,A> v, A arg)	Accepts the given visitor.
protected void	writeFields(JsonWriter out)

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

getIndex, getName, getOwner, hasOwner, internalSetIndex, internalSetName, internalSetOwner, readPart, 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.FieldOperations

container, getReverse, getReverseAnnotation, isContainer, isDerived, isRef, isReverse, isReverseOf

Field Details

FIELD__TYPE

public static final String FIELD__TYPE

Identifier for the Field type in JSON format.

See Also:

• Constant Field Values

TRANSIENT__PROP

public static final String TRANSIENT__PROP

See Also:

• isTransient()
• Constant Field Values

REPEATED__PROP

public static final String REPEATED__PROP

See Also:

• isRepeated()
• Constant Field Values

TYPE__PROP

public static final String TYPE__PROP

See Also:

• getType()
• Constant Field Values

Constructor Details

Field

protected Field()

Creates a Field instance.

See Also:

• create()

Method Details

create

public static Field create()

Creates a Field instance.

kind

public WithOptions.TypeKind kind()

Description copied from class: WithOptions

The type code of this instance.

Specified by:

kind in class WithOptions

isTransient

public final boolean isTransient()

Whether this field is not serialized when a message is created.

setTransient

public Field setTransient(boolean value)

See Also:

• isTransient()

internalSetTransient

protected final void internalSetTransient(boolean value)

Internal setter for isTransient() without chain call utility.

isRepeated

public final boolean isRepeated()

Whether this field contains multiple values of its getType().

setRepeated

public Field setRepeated(boolean value)

See Also:

• isRepeated()

internalSetRepeated

protected final void internalSetRepeated(boolean value)

Internal setter for isRepeated() without chain call utility.

getType

public final Type getType()

The type of values that can be stored in this field.

setType

public Field setType(Type value)

See Also:

• getType()

internalSetType

protected final void internalSetType(Type value)

Internal setter for getType() without chain call utility.

hasType

public final boolean hasType()

Checks, whether getType() has a value.

setName

public Field setName(String value)

Overrides:

setName in class Part

See Also:

• Part.getName()

setIndex

public Field setIndex(int value)

Overrides:

setIndex in class Part

See Also:

• Part.getIndex()

setOwner

public Field setOwner(Definition value)

Overrides:

setOwner in class Part

See Also:

• Part.getOwner()

setComment

public Field setComment(String value)

Overrides:

setComment in class Part

See Also:

• DefinitionBase.getComment()

setOptions

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

Overrides:

setOptions in class Part

See Also:

• WithOptions.getOptions()

putOption

public Field putOption(String key,
 Option value)

Description copied from class: WithOptions

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

Overrides:

putOption in class Part

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 Part

get

public Object get(String field)

Specified by:

get in interface ReflectiveDataObject

Overrides:

get in class Part

set

public void set(String field,
 Object value)

Specified by:

set in interface ReflectiveDataObject

Overrides:

set in class Part

readField

public static Field readField(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 Part

Throws:

IOException

readField

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

Overrides:

readField in class Part

Throws:

IOException

self

public Field self()

Description copied from interface: FieldOperations

The implementation.

Specified by:

self in interface FieldOperations

visit

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

Description copied from class: Part

Accepts the given visitor.

Specified by:

visit in class Part