io.spine.tools.compiler.annotation

Class OptionAnnotator<D extends com.google.protobuf.Descriptors.GenericDescriptor>

java.lang.Object

io.spine.tools.compiler.annotation.Annotator

io.spine.tools.compiler.annotation.OptionAnnotator<D>

Type Parameters:

D - the proto descriptor type used to receive option value

public abstract class OptionAnnotator<D extends com.google.protobuf.Descriptors.GenericDescriptor>
extends Annotator

An Annotator which annotates Java sources basing on a given Protobuf option.

Subtypes are purposed for different Protobuf option types such as FileOptions, MessageOptions etc.

Depending on the option type, an annotator manages a corresponding Protobuf descriptor (e.g. FileDescriptorProto for FileOptions).

Nested Class Summary

Nested classes/interfaces inherited from class io.spine.tools.compiler.annotation.Annotator

Annotator.TypeDeclarationAnnotation

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OptionAnnotator(io.spine.code.java.ClassName annotation, ApiOption option, com.google.common.collect.ImmutableList<com.google.protobuf.Descriptors.FileDescriptor> fileDescriptors, java.nio.file.Path genProtoDir)

Method Summary

Modifier and Type	Method and Description
protected void	annotate(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor) Annotates the Java sources generated from the specified file descriptor.
protected void	annotateMessageTypes(com.google.protobuf.Descriptors.Descriptor type, com.google.protobuf.Descriptors.FileDescriptor file) Annotates message class and MessageOrBuilder interface that correspond to the passed type.
protected abstract void	annotateMultipleFiles(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor) Annotates the Java sources generated from the specified file descriptor if java_multiple_files proto file option is true.
protected abstract void	annotateOneFile(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor) Annotates the Java sources generated from the specified file descriptor if java_multiple_files proto file option is set to false.
protected ApiOption	option() Obtains the Protobuf API option to transform into a Java annotation.
protected abstract boolean	shouldAnnotate(D descriptor) Tells whether the generated program elements from the specified descriptor should be annotated.

Methods inherited from class io.spine.tools.compiler.annotation.Annotator

addAnnotation, annotate, annotate, descriptors, rewriteSource

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionAnnotator

protected OptionAnnotator(io.spine.code.java.ClassName annotation,
                          ApiOption option,
                          com.google.common.collect.ImmutableList<com.google.protobuf.Descriptors.FileDescriptor> fileDescriptors,
                          java.nio.file.Path genProtoDir)

Method Detail

annotate

protected final void annotate(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor)

Annotates the Java sources generated from the specified file descriptor.

annotateOneFile

protected abstract void annotateOneFile(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor)

Annotates the Java sources generated from the specified file descriptor if java_multiple_files proto file option is set to false.

Parameters:

fileDescriptor - the file descriptor

annotateMultipleFiles

protected abstract void annotateMultipleFiles(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor)

Annotates the Java sources generated from the specified file descriptor if java_multiple_files proto file option is true.

Parameters:

fileDescriptor - the file descriptor

shouldAnnotate

protected abstract boolean shouldAnnotate(D descriptor)

Tells whether the generated program elements from the specified descriptor should be annotated.

Parameters:

descriptor - the descriptor to extract option value.

Returns:

true if generated element should be annotated, false otherwise

option

protected final ApiOption option()

Obtains the Protobuf API option to transform into a Java annotation.

annotateMessageTypes

protected final void annotateMessageTypes(com.google.protobuf.Descriptors.Descriptor type,
                                          com.google.protobuf.Descriptors.FileDescriptor file)

Annotates message class and MessageOrBuilder interface that correspond to the passed type.