Package com.google.protobuf.compiler
Class PluginProtos.CodeGeneratorRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.protobuf.compiler.PluginProtos.CodeGeneratorRequest
- All Implemented Interfaces:
PluginProtos.CodeGeneratorRequestOrBuilder,Message,MessageLite,MessageLiteOrBuilder,MessageOrBuilder,Serializable
- Enclosing class:
- PluginProtos
public static final class PluginProtos.CodeGeneratorRequest
extends GeneratedMessageV3
implements PluginProtos.CodeGeneratorRequestOrBuilder
An encoded CodeGeneratorRequest is written to the plugin's stdin.Protobuf type
google.protobuf.compiler.CodeGeneratorRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAn encoded CodeGeneratorRequest is written to the plugin's stdin.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, GeneratedMessageV3.ExtendableMessage<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate intstatic final intprivate PluginProtos.Versionprivate static final PluginProtos.CodeGeneratorRequeststatic final intprivate LazyStringArrayListprivate byteprivate Objectstatic final intstatic final Parser<PluginProtos.CodeGeneratorRequest>Deprecated.static final intprivate List<DescriptorProtos.FileDescriptorProto>private static final longstatic final intprivate List<DescriptorProtos.FileDescriptorProto>Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateprivateCodeGeneratorRequest(GeneratedMessageV3.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompares the specified object with this message for equality.The version number of protocol compiler.The version number of protocol compiler.Get an instance of the type with no fields set.static final Descriptors.DescriptorgetFileToGenerate(int index) The .proto files that were explicitly listed on the command-line.getFileToGenerateBytes(int index) The .proto files that were explicitly listed on the command-line.intThe .proto files that were explicitly listed on the command-line.The .proto files that were explicitly listed on the command-line.The generator parameter passed on the command-line.The generator parameter passed on the command-line.TODO: Remove this unnecessary intermediate implementation of this method.getProtoFile(int index) FileDescriptorProtos for all files in files_to_generate and everything they import.intFileDescriptorProtos for all files in files_to_generate and everything they import.FileDescriptorProtos for all files in files_to_generate and everything they import.getProtoFileOrBuilder(int index) FileDescriptorProtos for all files in files_to_generate and everything they import.FileDescriptorProtos for all files in files_to_generate and everything they import.intGet the number of bytes required to encode this message.getSourceFileDescriptors(int index) File descriptors with all options, including source-retention options.intFile descriptors with all options, including source-retention options.File descriptors with all options, including source-retention options.getSourceFileDescriptorsOrBuilder(int index) File descriptors with all options, including source-retention options.File descriptors with all options, including source-retention options.booleanThe version number of protocol compiler.inthashCode()Returns the hash code value for this message.booleanThe generator parameter passed on the command-line.protected GeneratedMessageV3.FieldAccessorTableGet the FieldAccessorTable for this type.final booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.newBuilder(PluginProtos.CodeGeneratorRequest prototype) Constructs a new builder for a message of the same type as this message.TODO: remove this together with GeneratedMessageV3.BuilderParent.protected ObjectCreates a new instance of this message type.parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) parseFrom(ByteString data) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) parseFrom(CodedInputStream input) parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()Constructs a builder initialized with the current message.voidwriteTo(CodedOutputStream output) Serializes the message and writes it tooutput.Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
FILE_TO_GENERATE_FIELD_NUMBER
public static final int FILE_TO_GENERATE_FIELD_NUMBER- See Also:
-
fileToGenerate_
-
PARAMETER_FIELD_NUMBER
public static final int PARAMETER_FIELD_NUMBER- See Also:
-
parameter_
-
PROTO_FILE_FIELD_NUMBER
public static final int PROTO_FILE_FIELD_NUMBER- See Also:
-
protoFile_
-
SOURCE_FILE_DESCRIPTORS_FIELD_NUMBER
public static final int SOURCE_FILE_DESCRIPTORS_FIELD_NUMBER- See Also:
-
sourceFileDescriptors_
-
COMPILER_VERSION_FIELD_NUMBER
public static final int COMPILER_VERSION_FIELD_NUMBER- See Also:
-
compilerVersion_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
Deprecated.
-
-
Constructor Details
-
CodeGeneratorRequest
-
CodeGeneratorRequest
private CodeGeneratorRequest()
-
-
Method Details
-
newInstance
Description copied from class:GeneratedMessageV3Creates a new instance of this message type. Overridden in the generated code.- Overrides:
newInstancein classGeneratedMessageV3
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTablein classGeneratedMessageV3
-
getFileToGenerateList
The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.
repeated string file_to_generate = 1;- Specified by:
getFileToGenerateListin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- A list containing the fileToGenerate.
-
getFileToGenerateCount
public int getFileToGenerateCount()The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.
repeated string file_to_generate = 1;- Specified by:
getFileToGenerateCountin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The count of fileToGenerate.
-
getFileToGenerate
The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.
repeated string file_to_generate = 1;- Specified by:
getFileToGeneratein interfacePluginProtos.CodeGeneratorRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The fileToGenerate at the given index.
-
getFileToGenerateBytes
The .proto files that were explicitly listed on the command-line. The code generator should generate code only for these files. Each file's descriptor will be included in proto_file, below.
repeated string file_to_generate = 1;- Specified by:
getFileToGenerateBytesin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the fileToGenerate at the given index.
-
hasParameter
public boolean hasParameter()The generator parameter passed on the command-line.
optional string parameter = 2;- Specified by:
hasParameterin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- Whether the parameter field is set.
-
getParameter
The generator parameter passed on the command-line.
optional string parameter = 2;- Specified by:
getParameterin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The parameter.
-
getParameterBytes
The generator parameter passed on the command-line.
optional string parameter = 2;- Specified by:
getParameterBytesin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The bytes for parameter.
-
getProtoFileList
FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.
repeated .google.protobuf.FileDescriptorProto proto_file = 15;- Specified by:
getProtoFileListin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getProtoFileOrBuilderList
FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.
repeated .google.protobuf.FileDescriptorProto proto_file = 15;- Specified by:
getProtoFileOrBuilderListin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getProtoFileCount
public int getProtoFileCount()FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.
repeated .google.protobuf.FileDescriptorProto proto_file = 15;- Specified by:
getProtoFileCountin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getProtoFile
FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.
repeated .google.protobuf.FileDescriptorProto proto_file = 15;- Specified by:
getProtoFilein interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getProtoFileOrBuilder
FileDescriptorProtos for all files in files_to_generate and everything they import. The files will appear in topological order, so each file appears before any file that imports it. Note: the files listed in files_to_generate will include runtime-retention options only, but all other files will include source-retention options. The source_file_descriptors field below is available in case you need source-retention options for files_to_generate. protoc guarantees that all proto_files will be written after the fields above, even though this is not technically guaranteed by the protobuf wire format. This theoretically could allow a plugin to stream in the FileDescriptorProtos and handle them one by one rather than read the entire set into memory at once. However, as of this writing, this is not similarly optimized on protoc's end -- it will store all fields in memory at once before sending them to the plugin. Type names of fields and extensions in the FileDescriptorProto are always fully qualified.
repeated .google.protobuf.FileDescriptorProto proto_file = 15;- Specified by:
getProtoFileOrBuilderin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getSourceFileDescriptorsList
File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.
repeated .google.protobuf.FileDescriptorProto source_file_descriptors = 17;- Specified by:
getSourceFileDescriptorsListin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getSourceFileDescriptorsOrBuilderList
public List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder> getSourceFileDescriptorsOrBuilderList()File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.
repeated .google.protobuf.FileDescriptorProto source_file_descriptors = 17;- Specified by:
getSourceFileDescriptorsOrBuilderListin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getSourceFileDescriptorsCount
public int getSourceFileDescriptorsCount()File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.
repeated .google.protobuf.FileDescriptorProto source_file_descriptors = 17;- Specified by:
getSourceFileDescriptorsCountin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getSourceFileDescriptors
File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.
repeated .google.protobuf.FileDescriptorProto source_file_descriptors = 17;- Specified by:
getSourceFileDescriptorsin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
getSourceFileDescriptorsOrBuilder
File descriptors with all options, including source-retention options. These descriptors are only provided for the files listed in files_to_generate.
repeated .google.protobuf.FileDescriptorProto source_file_descriptors = 17;- Specified by:
getSourceFileDescriptorsOrBuilderin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
hasCompilerVersion
public boolean hasCompilerVersion()The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;- Specified by:
hasCompilerVersionin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- Whether the compilerVersion field is set.
-
getCompilerVersion
The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;- Specified by:
getCompilerVersionin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The compilerVersion.
-
getCompilerVersionOrBuilder
The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;- Specified by:
getCompilerVersionOrBuilderin interfacePluginProtos.CodeGeneratorRequestOrBuilder
-
isInitialized
public final boolean isInitialized()Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessageV3
-
writeTo
Description copied from interface:MessageLiteSerializes the message and writes it tooutput. This does not flush or close the stream.- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classGeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLiteGet the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.- Specified by:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classGeneratedMessageV3
-
equals
Description copied from interface:MessageCompares the specified object with this message for equality. Returnstrueif the given object is a message of the same type (as defined bygetDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()is incorrect.- Specified by:
equalsin interfaceMessage- Overrides:
equalsin classAbstractMessage- Parameters:
obj- object to be compared for equality with this message- Returns:
trueif the specified object is equal to this message
-
hashCode
public int hashCode()Description copied from interface:MessageReturns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheritingObject.hashCode()is incorrect.- Specified by:
hashCodein interfaceMessage- Overrides:
hashCodein classAbstractMessage- Returns:
- the hash code value for this message
- See Also:
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
Description copied from interface:MessageLiteConstructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForTypein interfaceMessage- Specified by:
newBuilderForTypein interfaceMessageLite
-
newBuilder
-
newBuilder
public static PluginProtos.CodeGeneratorRequest.Builder newBuilder(PluginProtos.CodeGeneratorRequest prototype) -
toBuilder
Description copied from interface:MessageLiteConstructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilderin interfaceMessage- Specified by:
toBuilderin interfaceMessageLite
-
newBuilderForType
protected PluginProtos.CodeGeneratorRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent) Description copied from class:GeneratedMessageV3TODO: remove this together with GeneratedMessageV3.BuilderParent.- Specified by:
newBuilderForTypein classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from class:GeneratedMessageV3TODO: Remove this unnecessary intermediate implementation of this method.- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessageV3
-
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilderGet an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from thegetDefaultInstance()method of generated message classes in that this method is an abstract method of theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-