Annotation Type AutoProtoSchemaBuilder

  • @Target({TYPE,PACKAGE})
    public @interface AutoProtoSchemaBuilder
    Generates compile-time auto-implementations of SerializationContextInitializer. Annotate a class or interface extending from SerializationContextInitializer with this annotation and a new concrete public class named based on className(), having a default no-arguments public constructor will be generated at compile time in the same package. The implementations of the methods from SerializationContextInitializer will be generated based on the information provided in the attributes of this annotation.

    This annotation is used at compile time annotation processing only and should not be relied upon at runtime, so its retention is set to RetentionPolicy.CLASS.

    NOTE: This annotation can also be used on packages but this kind of usage has been deprecated in 4.3.4 and will be removed in version 5. See IPROTO-157.

    [email protected]
    • Element Detail

      • className

        String className
        The name of the generated Java implementation class (optional). If missing, the name of the current class plus the "Impl" suffix is assumed by default.
      • schemaFilePath

        String schemaFilePath
        Generated Protobuf schema resource file path (optional). If this is present then a resource file is generated in the designated path, with the given file name, and will be available to the ClassLoader at runtime, otherwise the generated schema file is directly baked as a String constant into the generated class and no resource file is generated.
      • schemaPackageName

        String schemaPackageName
        Package of the generated Protobuf schema. This is optional. If the package name is not specified then the unnamed/default package is assumed.
      • basePackages

        String[] basePackages
        The list of packages to scan (optional). basePackages and includeClasses() are mutually exclusive. The packages are scanned for annotated classes recursively. If basePackages is empty then all packages are considered, starting from root and including the default (unnamed) package. The packages are filtered based on the excludeClasses() filter. If neither includeClasses() nor basePackages is specified then the entire source path is scanned. Be wary of using this last option in anything but very simple demo projects.
      • includeClasses

        Class<?>[] includeClasses
        Annotated classes to process (optional). If includeClasses is empty, all ProtoXyz annotated classes that belong to the packages listed in basePackages() will be scanned. If neither includeClasses nor basePackages() was specified then the entire source path will be scanned. Be wary of using this last option in anything but very simple demo projects.
      • excludeClasses

        Class<?>[] excludeClasses
        Classes to be explicitly excluded. excludeClasses and includeClasses() are mutually exclusive. This can be used together with basePackages().
      • autoImportClasses

        boolean autoImportClasses
        since 4.3.4. This will be removed in version 5. See IPROTO-158.
        Indicates if we accept classes not explicitly included by the includeClasses() or basePackages() to be auto-detected by reference from the already included classes and to be added automatically. If this is set to false (which is the default) it results in a compilation error when such a case is encountered.
      • service

        boolean service
        Enable generation of a META-INF/services file for the generated implementation class of the SerializationContextInitializer to be loadable by the ServiceLoader. This defaults to true. The ProtoStream library does not make any use of the ServiceLoader to benefit from this mechanism but the user's application is free to use it.
      • marshallersOnly

        boolean marshallersOnly
        Generate only the marshallers and skip the schema file.

        The schema is actually always generated at compile time, in memory, so that various validations can be performed at compile time, but with this flag you effectively ensure it finally gets excluded from both the generated source code and the generated resource files and it does not get registered at runtime by this SerializationContextInitializer implementation. This flag is useful in cases where you want to register the schema manually for whatever reason or the schema is already provided/registered by other parts of your application.

        This option conflicts with schemaFilePath() and they cannot be used together. Also, this option cannot be set to true if the annotated element is a subtype of GeneratedSchema, which is expected to always provide a generated schema, as the name implies.