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
Static Fields
COMPILER_VERSION_FIELD_NUMBER
public static final int COMPILER_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILE_TO_GENERATE_FIELD_NUMBER
public static final int FILE_TO_GENERATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARAMETER_FIELD_NUMBER
public static final int PARAMETER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARSER
public static final Parser<PluginProtos.CodeGeneratorRequest> PARSER
PROTO_FILE_FIELD_NUMBER
public static final int PROTO_FILE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PluginProtos.CodeGeneratorRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PluginProtos.CodeGeneratorRequest.Builder newBuilder()
newBuilder(PluginProtos.CodeGeneratorRequest prototype)
public static PluginProtos.CodeGeneratorRequest.Builder newBuilder(PluginProtos.CodeGeneratorRequest prototype)
public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(InputStream input)
public static PluginProtos.CodeGeneratorRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input)
public static PluginProtos.CodeGeneratorRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorRequest parseFrom(InputStream input)
public static PluginProtos.CodeGeneratorRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PluginProtos.CodeGeneratorRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Compares the specified object with this message for equality. Returns true if the given
object is a message of the same type (as defined by getDescriptorForType()) and has
identical values for all of its fields. Subclasses must implement this; inheriting
Object.equals() is incorrect.
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCompilerVersion()
public PluginProtos.Version getCompilerVersion()
The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;
getCompilerVersionOrBuilder()
public PluginProtos.VersionOrBuilder getCompilerVersionOrBuilder()
The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;
getDefaultInstanceForType()
public PluginProtos.CodeGeneratorRequest getDefaultInstanceForType()
Get 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 the getDefaultInstance() method of generated
message classes in that this method is an abstract method of the MessageLite interface
whereas getDefaultInstance() is a static method of a specific class. They return the
same thing.
getFileToGenerate(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The fileToGenerate at the given index.
|
getFileToGenerateBytes(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the fileToGenerate at the given index.
|
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;
| Returns |
|---|
| Type | Description |
int | The count of fileToGenerate.
|
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;
getParameter()
public String getParameter()
The generator parameter passed on the command-line.
optional string parameter = 2;
| Returns |
|---|
| Type | Description |
String | The parameter.
|
getParameterBytes()
public ByteString getParameterBytes()
The generator parameter passed on the command-line.
optional string parameter = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parameter.
|
getParserForType()
public Parser<PluginProtos.CodeGeneratorRequest> getParserForType()
Overrides
getProtoFile(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
int | |
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;
getProtoFileOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.DescriptorProtos.FileDescriptorProtoOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Get 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.
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasCompilerVersion()
public boolean hasCompilerVersion()
The version number of protocol compiler.
optional .google.protobuf.compiler.Version compiler_version = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the compilerVersion field is set.
|
hasParameter()
public boolean hasParameter()
The generator parameter passed on the command-line.
optional string parameter = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the parameter field is set.
|
hashCode()
Returns 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; inheriting Object.hashCode() is incorrect.
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type. We can't have the message
class pass this in to the constructor because of bootstrapping trouble
with DescriptorProtos.
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PluginProtos.CodeGeneratorRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PluginProtos.CodeGeneratorRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Creates a new instance of this message type. Overridden in the generated code.
toBuilder()
public PluginProtos.CodeGeneratorRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Serializes the message and writes it to output. This does not flush or close the
stream.
