Package io.protostuff.parser

Class AnnotationContainer

java.lang.Object

io.protostuff.parser.AnnotationContainer

All Implemented Interfaces:

HasAnnotations, HasProto

Direct Known Subclasses:

EnumGroup, EnumGroup.Value, Extension, Field, Message, Proto, Service, Service.RpcMethod

public abstract class AnnotationContainer
extends java.lang.Object
implements HasAnnotations, HasProto

Base class for components that contain annotations.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.LinkedHashMap<java.lang.String,Annotation>	annotations
(package private) java.util.ArrayList<java.lang.String>	docs

Constructor Summary

Constructors

Constructor	Description
AnnotationContainer()

Method Summary

Modifier and Type	Method	Description
void	add(Annotation annotation)	Adds the annoation.
boolean	addAnnotations(java.util.Map<java.lang.String,Annotation> source, boolean clearSource)	Adds all the annotations to this container.
void	addDoc(java.lang.String doc)
static java.lang.IllegalStateException	err(java.lang.String msg, Proto proto)
java.util.Map<java.lang.String,Annotation>	getA()	Short-hand for getAnnotationMap().
Annotation	getAnnotation(java.lang.String name)	Gets the annotation by key/name.
java.util.Map<java.lang.String,Annotation>	getAnnotationMap()	Gets the annotation map.
java.util.Collection<Annotation>	getAnnotations()	Gets the annotations.
java.util.ArrayList<java.lang.String>	getDocs()
boolean	hasAnnotation(java.lang.String name)
boolean	isEmptyA()	Shorthand for annotations.isEmpty().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.protostuff.parser.HasProto

getProto

Field Detail

annotations

final java.util.LinkedHashMap<java.lang.String,Annotation> annotations

docs

final java.util.ArrayList<java.lang.String> docs

Constructor Detail

AnnotationContainer

public AnnotationContainer()

Method Detail

getDocs

public java.util.ArrayList<java.lang.String> getDocs()

addDoc

public void addDoc(java.lang.String doc)

add

public void add(Annotation annotation)

Description copied from interface: HasAnnotations

Adds the annoation.

Specified by:

add in interface HasAnnotations

getAnnotationMap

public java.util.Map<java.lang.String,Annotation> getAnnotationMap()

Description copied from interface: HasAnnotations

Gets the annotation map.

Specified by:

getAnnotationMap in interface HasAnnotations

getA

public final java.util.Map<java.lang.String,Annotation> getA()

Short-hand for getAnnotationMap().

You then can use:

 <if(message.a.("SomeAnnotation"))>
 

getAnnotations

public java.util.Collection<Annotation> getAnnotations()

Description copied from interface: HasAnnotations

Gets the annotations.

Specified by:

getAnnotations in interface HasAnnotations

getAnnotation

public Annotation getAnnotation(java.lang.String name)

Description copied from interface: HasAnnotations

Gets the annotation by key/name.

Specified by:

getAnnotation in interface HasAnnotations

hasAnnotation

public boolean hasAnnotation(java.lang.String name)

addAnnotations

public boolean addAnnotations(java.util.Map<java.lang.String,Annotation> source,
                              boolean clearSource)

Description copied from interface: HasAnnotations

Adds all the annotations to this container. If clearSource is true, the source arg is cleared.

Specified by:

addAnnotations in interface HasAnnotations

isEmptyA

public final boolean isEmptyA()

Shorthand for annotations.isEmpty().

 You can then use:
 <if(message.emptyA)>
 

 Note that this does not work on stringtemplate:
 <if(message.annotationMap.empty)>
 
 Even though Map.isEmpty() exists.
 

err

public static java.lang.IllegalStateException err(java.lang.String msg,
                                                  Proto proto)