java.lang.Object
- org.infinispan.protostream.annotations.ProtoSchemaBuilder

```
public final class ProtoSchemaBuilder
extends Object
```
Generates a Protocol Buffers schema definition file and associated marshallers based on a set of @Proto* annotated classes.
See ProtoName, ProtoMessage, ProtoField, ProtoEnum, ProtoEnumValue, ProtoDoc and ProtoUnknownFieldSet.
This class performs run-time generation. For a compile-time equivalent see AutoProtoSchemaBuilder and SerializationContextInitializer.

Since:

3.0

Author:

[email protected]

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_GENERATED_SCHEMA_NAME`
`static String`	`FILE_LONG_OPT`
`static String`	`FILE_OPT`
`static boolean`	`generateSchemaDebugComments`	Set this flag to `true` to enable output of debug comments in the generated Protobuf schema.
`static String`	`HELP_LONG_OPT`
`static String`	`HELP_OPT`
`static String`	`MARSHALLER_LONG_OPT`
`static String`	`MARSHALLER_OPT`
`static String`	`PACKAGE_LONG_OPT`
`static String`	`PACKAGE_OPT`
`static String`	`SCHEMA_LONG_OPT`
`static String`	`SCHEMA_OPT`

Constructor Summary

Constructors
Constructor Description

ProtoSchemaBuilder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProtoSchemaBuilder`	`addClass(Class<?> clazz)`	Add a @ProtoXyz annotated class to be analyzed.
`ProtoSchemaBuilder`	`addClasses(Class<?>... classes)`	Add several @ProtoXyz annotated classes to be analyzed.
`ProtoSchemaBuilder`	`autoImportClasses(boolean autoImportClasses)`	A flag to control processing of classes that were not directly added but were discovered by auto-import.
`String`	`build(SerializationContext serializationContext)`	Builds the Protocol Buffers schema file defining the types and generates marshaller implementations for these types and registers everything with the given `SerializationContext`.
`ProtoSchemaBuilder`	`fileName(String fileName)`	Set the name of the Protobuf schema file to generate.
`static void`	`main(String[] args)`
`ProtoSchemaBuilder`	`packageName(String packageName)`	Set the name of the Protobuf package to generate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_GENERATED_SCHEMA_NAME
```
public static final String DEFAULT_GENERATED_SCHEMA_NAME
```
    See Also:
    
    Constant Field Values
  - FILE_OPT
```
public static final String FILE_OPT
```
    See Also:
    
    Constant Field Values
  - FILE_LONG_OPT
```
public static final String FILE_LONG_OPT
```
    See Also:
    
    Constant Field Values
  - PACKAGE_OPT
```
public static final String PACKAGE_OPT
```
    See Also:
    
    Constant Field Values
  - PACKAGE_LONG_OPT
```
public static final String PACKAGE_LONG_OPT
```
    See Also:
    
    Constant Field Values
  - HELP_OPT
```
public static final String HELP_OPT
```
    See Also:
    
    Constant Field Values
  - HELP_LONG_OPT
```
public static final String HELP_LONG_OPT
```
    See Also:
    
    Constant Field Values
  - MARSHALLER_OPT
```
public static final String MARSHALLER_OPT
```
    See Also:
    
    Constant Field Values
  - MARSHALLER_LONG_OPT
```
public static final String MARSHALLER_LONG_OPT
```
    See Also:
    
    Constant Field Values
  - SCHEMA_OPT
```
public static final String SCHEMA_OPT
```
    See Also:
    
    Constant Field Values
  - SCHEMA_LONG_OPT
```
public static final String SCHEMA_LONG_OPT
```
    See Also:
    
    Constant Field Values
  - generateSchemaDebugComments
```
public static boolean generateSchemaDebugComments
```
    Set this flag to true to enable output of debug comments in the generated Protobuf schema.
- Constructor Detail
  - ProtoSchemaBuilder
```
public ProtoSchemaBuilder()
```
- Method Detail
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception
  - fileName
```
public ProtoSchemaBuilder fileName(String fileName)
```
    Set the name of the Protobuf schema file to generate. This is mandatory. The resulting file will be registered in the SerializationContext with this given name.
    
    Parameters:
    
    fileName - the name of the file to generate
    
    Returns:
    
    itself
  - packageName
```
public ProtoSchemaBuilder packageName(String packageName)
```
    Set the name of the Protobuf package to generate. This is optional.
    
    Parameters:
    
    packageName - the package name
    
    Returns:
    
    itself, to help chaining calls
  - addClass
```
public ProtoSchemaBuilder addClass(Class<?> clazz)
```
    Add a @ProtoXyz annotated class to be analyzed. Proto schema and marshaller will be generated for it.
    Its superclass and superinterfaces will be also included in the analysis but no separate Protobuf types and marshallers will be generated for them as Protobuf does not have any notion of type hierarchy and inheritance. The fields defined by the superclass or superinterfaces will be just included in the schema of the derived class.
    Its inner classes will also be automatically processed if they are referenced by the outer class. If you want to make sure an inner class is processed regardless if referenced or not you will have to add it explicitly using #addClass or addClasses(java.lang.Class<?>...).
    
    Parameters:
    
    clazz - the class to analyze
    
    Returns:
    
    itself, to help chaining calls
  - addClasses
```
public ProtoSchemaBuilder addClasses(Class<?>... classes)
```
    Add several @ProtoXyz annotated classes to be analyzed. Proto schema and marshaller will be generated for them.
    Their superclasses and superinterfaces will be also included in the analysis but no separate Protobuf types and marshallers will be generated for them as Protobuf does not have any notion of type hierarchy and inheritance. The fields defined by the superclass or superinterfaces will be just included in the schema of the derived class.
    Inner classes will also be automatically processed if they are referenced by the outer class. If you want to make sure an inner class is processed regardless if referenced or not you will have to add it explicitly using addClass(java.lang.Class<?>) or #addClasses.
    
    Parameters:
    
    classes - the classes to analyze
    
    Returns:
    
    itself, to help chaining calls
  - autoImportClasses
```
public ProtoSchemaBuilder autoImportClasses(boolean autoImportClasses)
```
    A flag to control processing of classes that were not directly added but were discovered by auto-import. When such a class is found an error will be generated if autoImportClasses is turned off. This flag is true by default to make your life easier but can be turned off when you need to be very specific about which classes are to be processed.
    
    Parameters:
    
    autoImportClasses -
    
    Returns:
    
    itself, to help chaining calls
  - build
```
public String build(SerializationContext serializationContext)
             throws ProtoSchemaBuilderException,
                    IOException
```
    Builds the Protocol Buffers schema file defining the types and generates marshaller implementations for these types and registers everything with the given SerializationContext.
    
    Parameters:
    
    serializationContext -
    
    Returns:
    
    the generated Protocol Buffers schema file text
    
    Throws:
    
    ProtoSchemaBuilderException
    
    IOException

Class ProtoSchemaBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_GENERATED_SCHEMA_NAME

FILE_OPT

FILE_LONG_OPT

PACKAGE_OPT

PACKAGE_LONG_OPT

HELP_OPT

HELP_LONG_OPT

MARSHALLER_OPT

MARSHALLER_LONG_OPT

SCHEMA_OPT

SCHEMA_LONG_OPT

generateSchemaDebugComments

Constructor Detail

ProtoSchemaBuilder

Method Detail

main

fileName

packageName

addClass

addClasses

autoImportClasses

build