org.infinispan.protostream.annotations

Annotation Type ProtoField

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface ProtoField

Defines a Protocol Buffers message field. A class must have at least one field/property annotated with ProtoField in order to be considered a Protocol Buffers message type.

Since:

3.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	number The Protocol Buffers tag number.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends java.util.Collection>	collectionImplementation
java.lang.String	defaultValue
java.lang.Class<?>	javaType
java.lang.String	name
boolean	required
Type	type

Element Detail

number

public abstract int number

The Protocol Buffers tag number.

type

public abstract Type type

Default:

org.infinispan.protostream.descriptors.Type.MESSAGE

required

public abstract boolean required

Default:

false

name

public abstract java.lang.String name

Default:

""

defaultValue

public abstract java.lang.String defaultValue

Default:

""

javaType

public abstract java.lang.Class<?> javaType

Default:

void.class

collectionImplementation

public abstract java.lang.Class<? extends java.util.Collection> collectionImplementation

Default:

java.util.Collection.class