org.infinispan.protostream.annotations

Class ProtoSchemaBuilder

java.lang.Object

org.infinispan.protostream.annotations.ProtoSchemaBuilder

public final class ProtoSchemaBuilder
extends java.lang.Object

Generates a Protocol Buffers schema definition file based on a set of @Proto* annotated classes.

See ProtoMessage, ProtoField, ProtoEnum, ProtoEnumValue and ProtoUnknownFieldSet.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.Class<?>>	classes
private java.lang.String	fileName
static boolean	generateSchemaDebugComments Set this to true to enable output of debug comments in the generated protobuf schema.
private java.lang.String	packageName

Constructor Summary

Constructors

Constructor and Description
ProtoSchemaBuilder()

Method Summary

Modifier and Type	Method and Description
ProtoSchemaBuilder	addClass(java.lang.Class<?> clazz)
java.lang.String	build(SerializationContext serializationContext) Builds the Protocol Buffers schema file and marshallers and registers them with the given SerializationContext.
ProtoSchemaBuilder	fileName(java.lang.String fileName)
static void	main(java.lang.String[] args)
ProtoSchemaBuilder	packageName(java.lang.String packageName)

Methods inherited from class java.lang.Object

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

Field Detail

generateSchemaDebugComments

public static boolean generateSchemaDebugComments

Set this to true to enable output of debug comments in the generated protobuf schema.

fileName

private java.lang.String fileName

packageName

private java.lang.String packageName

classes

private final java.util.Set<java.lang.Class<?>> classes

Constructor Detail

ProtoSchemaBuilder

public ProtoSchemaBuilder()

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

fileName

public ProtoSchemaBuilder fileName(java.lang.String fileName)

packageName

public ProtoSchemaBuilder packageName(java.lang.String packageName)

addClass

public ProtoSchemaBuilder addClass(java.lang.Class<?> clazz)

build

public java.lang.String build(SerializationContext serializationContext)
                       throws ProtoSchemaBuilderException,
                              java.io.IOException

Builds the Protocol Buffers schema file and marshallers and registers them with the given SerializationContext.

Parameters:

serializationContext -

Returns:

the generated Protocol Buffers schema file

Throws:

ProtoSchemaBuilderException

java.io.IOException