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 typegoogle.protobuf.compiler.CodeGeneratorRequest- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPluginProtos.CodeGeneratorRequest.BuilderAn encoded CodeGeneratorRequest is written to the plugin's stdin.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
-
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
-
Field Summary
Fields Modifier and Type Field Description static intCOMPILER_VERSION_FIELD_NUMBERstatic intFILE_TO_GENERATE_FIELD_NUMBERstatic intPARAMETER_FIELD_NUMBERstatic Parser<PluginProtos.CodeGeneratorRequest>PARSERDeprecated.static intPROTO_FILE_FIELD_NUMBER-
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
-
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
-
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Compares the specified object with this message for equality.PluginProtos.VersiongetCompilerVersion()The version number of protocol compiler.PluginProtos.VersionOrBuildergetCompilerVersionOrBuilder()The version number of protocol compiler.static PluginProtos.CodeGeneratorRequestgetDefaultInstance()PluginProtos.CodeGeneratorRequestgetDefaultInstanceForType()Get an instance of the type with no fields set.static Descriptors.DescriptorgetDescriptor()StringgetFileToGenerate(int index)The .proto files that were explicitly listed on the command-line.ByteStringgetFileToGenerateBytes(int index)The .proto files that were explicitly listed on the command-line.intgetFileToGenerateCount()The .proto files that were explicitly listed on the command-line.ProtocolStringListgetFileToGenerateList()The .proto files that were explicitly listed on the command-line.StringgetParameter()The generator parameter passed on the command-line.ByteStringgetParameterBytes()The generator parameter passed on the command-line.Parser<PluginProtos.CodeGeneratorRequest>getParserForType()Gets the parser for a message of the same type as this message.DescriptorProtos.FileDescriptorProtogetProtoFile(int index)FileDescriptorProtos for all files in files_to_generate and everything they import.intgetProtoFileCount()FileDescriptorProtos for all files in files_to_generate and everything they import.List<DescriptorProtos.FileDescriptorProto>getProtoFileList()FileDescriptorProtos for all files in files_to_generate and everything they import.DescriptorProtos.FileDescriptorProtoOrBuildergetProtoFileOrBuilder(int index)FileDescriptorProtos for all files in files_to_generate and everything they import.List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder>getProtoFileOrBuilderList()FileDescriptorProtos for all files in files_to_generate and everything they import.intgetSerializedSize()Get the number of bytes required to encode this message.UnknownFieldSetgetUnknownFields()Get theUnknownFieldSetfor this message.booleanhasCompilerVersion()The version number of protocol compiler.inthashCode()Returns the hash code value for this message.booleanhasParameter()The generator parameter passed on the command-line.protected GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()Get the FieldAccessorTable for this type.booleanisInitialized()Returns true if all required fields in the message and all embedded messages are set, false otherwise.static PluginProtos.CodeGeneratorRequest.BuildernewBuilder()static PluginProtos.CodeGeneratorRequest.BuildernewBuilder(PluginProtos.CodeGeneratorRequest prototype)PluginProtos.CodeGeneratorRequest.BuildernewBuilderForType()Constructs a new builder for a message of the same type as this message.protected PluginProtos.CodeGeneratorRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParent parent)TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.protected ObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameter unused)Creates a new instance of this message type.static PluginProtos.CodeGeneratorRequestparseDelimitedFrom(InputStream input)static PluginProtos.CodeGeneratorRequestparseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)static PluginProtos.CodeGeneratorRequestparseFrom(byte[] data)static PluginProtos.CodeGeneratorRequestparseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)static PluginProtos.CodeGeneratorRequestparseFrom(ByteString data)static PluginProtos.CodeGeneratorRequestparseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)static PluginProtos.CodeGeneratorRequestparseFrom(CodedInputStream input)static PluginProtos.CodeGeneratorRequestparseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)static PluginProtos.CodeGeneratorRequestparseFrom(InputStream input)static PluginProtos.CodeGeneratorRequestparseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)static PluginProtos.CodeGeneratorRequestparseFrom(ByteBuffer data)static PluginProtos.CodeGeneratorRequestparseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)static Parser<PluginProtos.CodeGeneratorRequest>parser()PluginProtos.CodeGeneratorRequest.BuildertoBuilder()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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
-
-
-
Field Detail
-
FILE_TO_GENERATE_FIELD_NUMBER
public static final int FILE_TO_GENERATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARAMETER_FIELD_NUMBER
public static final int PARAMETER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PROTO_FILE_FIELD_NUMBER
public static final int PROTO_FILE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COMPILER_VERSION_FIELD_NUMBER
public static final int COMPILER_VERSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARSER
@Deprecated public static final Parser<PluginProtos.CodeGeneratorRequest> PARSER
Deprecated.
-
-
Method Detail
-
newInstance
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Description copied from class:GeneratedMessageV3Creates a new instance of this message type. Overridden in the generated code.- Overrides:
newInstancein classGeneratedMessageV3
-
getUnknownFields
public final UnknownFieldSet getUnknownFields()
Description copied from interface:MessageOrBuilderGet theUnknownFieldSetfor this message.- Specified by:
getUnknownFieldsin interfaceMessageOrBuilder- Overrides:
getUnknownFieldsin classGeneratedMessageV3
-
getDescriptor
public static final Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected GeneratedMessageV3.FieldAccessorTable 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
public ProtocolStringList 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
public String getFileToGenerate(int index)
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
public ByteString getFileToGenerateBytes(int index)
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
public String getParameter()
The generator parameter passed on the command-line.
optional string parameter = 2;- Specified by:
getParameterin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The parameter.
-
getParameterBytes
public ByteString getParameterBytes()
The generator parameter passed on the command-line.
optional string parameter = 2;- Specified by:
getParameterBytesin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The bytes for parameter.
-
getProtoFileList
public List<DescriptorProtos.FileDescriptorProto> 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. 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
public List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder> 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. 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. 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
public DescriptorProtos.FileDescriptorProto getProtoFile(int index)
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. 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
public DescriptorProtos.FileDescriptorProtoOrBuilder getProtoFileOrBuilder(int index)
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. 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
-
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
public PluginProtos.Version getCompilerVersion()
The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;- Specified by:
getCompilerVersionin interfacePluginProtos.CodeGeneratorRequestOrBuilder- Returns:
- The compilerVersion.
-
getCompilerVersionOrBuilder
public PluginProtos.VersionOrBuilder 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
public void writeTo(CodedOutputStream output) throws IOException
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
public boolean equals(Object obj)
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:
Map.hashCode()
-
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
public static PluginProtos.CodeGeneratorRequest parseFrom(InputStream input) throws IOException
- 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
public PluginProtos.CodeGeneratorRequest.Builder 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
public static PluginProtos.CodeGeneratorRequest.Builder newBuilder()
-
newBuilder
public static PluginProtos.CodeGeneratorRequest.Builder newBuilder(PluginProtos.CodeGeneratorRequest prototype)
-
toBuilder
public PluginProtos.CodeGeneratorRequest.Builder 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(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.- Specified by:
newBuilderForTypein classGeneratedMessageV3
-
getDefaultInstance
public static PluginProtos.CodeGeneratorRequest getDefaultInstance()
-
parser
public static Parser<PluginProtos.CodeGeneratorRequest> parser()
-
getParserForType
public Parser<PluginProtos.CodeGeneratorRequest> getParserForType()
Description copied from interface:MessageLiteGets the parser for a message of the same type as this message.- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessageV3
-
getDefaultInstanceForType
public PluginProtos.CodeGeneratorRequest 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
-
-