java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.protobuf.compiler.PluginProtos.CodeGeneratorRequest

All Implemented Interfaces:

PluginProtos.CodeGeneratorRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

Enclosing class:

PluginProtos
```
public static final class PluginProtos.CodeGeneratorRequest
extends GeneratedMessage
implements PluginProtos.CodeGeneratorRequestOrBuilder
```
```
 An encoded CodeGeneratorRequest is written to the plugin's stdin.
 
```
Protobuf type google.protobuf.compiler.CodeGeneratorRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PluginProtos.CodeGeneratorRequest.Builder
An encoded CodeGeneratorRequest is written to the plugin's stdin.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
  GeneratedMessage.ExtendableBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, GeneratedMessage.ExtendableMessage<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT extends Message,T>, GeneratedMessage.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
  AbstractMessage.BuilderParent
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`bitField0_`
`static int`	`COMPILER_VERSION_FIELD_NUMBER`
`private PluginProtos.Version`	`compilerVersion_`
`private static PluginProtos.CodeGeneratorRequest`	`DEFAULT_INSTANCE`
`static int`	`FILE_TO_GENERATE_FIELD_NUMBER`
`private LazyStringArrayList`	`fileToGenerate_`
`private byte`	`memoizedIsInitialized`
`private java.lang.Object`	`parameter_`
`static int`	`PARAMETER_FIELD_NUMBER`
`private static Parser<PluginProtos.CodeGeneratorRequest>`	`PARSER`
`static int`	`PROTO_FILE_FIELD_NUMBER`
`private java.util.List<DescriptorProtos.FileDescriptorProto>`	`protoFile_`
`private static long`	`serialVersionUID`
`static int`	`SOURCE_FILE_DESCRIPTORS_FIELD_NUMBER`
`private java.util.List<DescriptorProtos.FileDescriptorProto>`	`sourceFileDescriptors_`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Constructor Summary

Constructors
Modifier Constructor Description

private CodeGeneratorRequest()

private CodeGeneratorRequest(GeneratedMessage.Builder<?> builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`	Compares the specified object with this message for equality.
`PluginProtos.Version`	`getCompilerVersion()`	The version number of protocol compiler.
`PluginProtos.VersionOrBuilder`	`getCompilerVersionOrBuilder()`	The version number of protocol compiler.
`static PluginProtos.CodeGeneratorRequest`	`getDefaultInstance()`
`PluginProtos.CodeGeneratorRequest`	`getDefaultInstanceForType()`	Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getFileToGenerate(int index)`	The .proto files that were explicitly listed on the command-line.
`ByteString`	`getFileToGenerateBytes(int index)`	The .proto files that were explicitly listed on the command-line.
`int`	`getFileToGenerateCount()`	The .proto files that were explicitly listed on the command-line.
`ProtocolStringList`	`getFileToGenerateList()`	The .proto files that were explicitly listed on the command-line.
`java.lang.String`	`getParameter()`	The generator parameter passed on the command-line.
`ByteString`	`getParameterBytes()`	The generator parameter passed on the command-line.
`Parser<PluginProtos.CodeGeneratorRequest>`	`getParserForType()`	TODO: Remove this unnecessary intermediate implementation of this method.
`DescriptorProtos.FileDescriptorProto`	`getProtoFile(int index)`	FileDescriptorProtos for all files in files_to_generate and everything they import.
`int`	`getProtoFileCount()`	FileDescriptorProtos for all files in files_to_generate and everything they import.
`java.util.List<DescriptorProtos.FileDescriptorProto>`	`getProtoFileList()`	FileDescriptorProtos for all files in files_to_generate and everything they import.
`DescriptorProtos.FileDescriptorProtoOrBuilder`	`getProtoFileOrBuilder(int index)`	FileDescriptorProtos for all files in files_to_generate and everything they import.
`java.util.List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder>`	`getProtoFileOrBuilderList()`	FileDescriptorProtos for all files in files_to_generate and everything they import.
`int`	`getSerializedSize()`	Get the number of bytes required to encode this message.
`DescriptorProtos.FileDescriptorProto`	`getSourceFileDescriptors(int index)`	File descriptors with all options, including source-retention options.
`int`	`getSourceFileDescriptorsCount()`	File descriptors with all options, including source-retention options.
`java.util.List<DescriptorProtos.FileDescriptorProto>`	`getSourceFileDescriptorsList()`	File descriptors with all options, including source-retention options.
`DescriptorProtos.FileDescriptorProtoOrBuilder`	`getSourceFileDescriptorsOrBuilder(int index)`	File descriptors with all options, including source-retention options.
`java.util.List<? extends DescriptorProtos.FileDescriptorProtoOrBuilder>`	`getSourceFileDescriptorsOrBuilderList()`	File descriptors with all options, including source-retention options.
`boolean`	`hasCompilerVersion()`	The version number of protocol compiler.
`int`	`hashCode()`	Returns the hash code value for this message.
`boolean`	`hasParameter()`	The generator parameter passed on the command-line.
`protected GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`	Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()`	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static PluginProtos.CodeGeneratorRequest.Builder`	`newBuilder()`
`static PluginProtos.CodeGeneratorRequest.Builder`	`newBuilder(PluginProtos.CodeGeneratorRequest prototype)`
`PluginProtos.CodeGeneratorRequest.Builder`	`newBuilderForType()`	Constructs a new builder for a message of the same type as this message.
`protected PluginProtos.CodeGeneratorRequest.Builder`	`newBuilderForType(AbstractMessage.BuilderParent parent)`	Create a nested builder.
`static PluginProtos.CodeGeneratorRequest`	`parseDelimitedFrom(java.io.InputStream input)`
`static PluginProtos.CodeGeneratorRequest`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(byte[] data)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(ByteString data)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(CodedInputStream input)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(java.io.InputStream input)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(java.nio.ByteBuffer data)`
`static PluginProtos.CodeGeneratorRequest`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Parser<PluginProtos.CodeGeneratorRequest>`	`parser()`
`PluginProtos.CodeGeneratorRequest.Builder`	`toBuilder()`	Constructs a builder initialized with the current message.
`void`	`writeTo(CodedOutputStream output)`	Serializes the message and writes it to `output`.

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
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, getUnknownFields, hasField, hasOneof

Field Detail

serialVersionUID
```
private static final long serialVersionUID
```
See Also:

Constant Field Values

bitField0_
```
private int bitField0_
```

FILE_TO_GENERATE_FIELD_NUMBER
```
public static final int FILE_TO_GENERATE_FIELD_NUMBER
```
See Also:

Constant Field Values

fileToGenerate_

private LazyStringArrayList fileToGenerate_

PARAMETER_FIELD_NUMBER
```
public static final int PARAMETER_FIELD_NUMBER
```
See Also:

Constant Field Values

parameter_

private volatile java.lang.Object parameter_

PROTO_FILE_FIELD_NUMBER
```
public static final int PROTO_FILE_FIELD_NUMBER
```
See Also:

Constant Field Values

protoFile_

private java.util.List<DescriptorProtos.FileDescriptorProto> protoFile_

SOURCE_FILE_DESCRIPTORS_FIELD_NUMBER
```
public static final int SOURCE_FILE_DESCRIPTORS_FIELD_NUMBER
```
See Also:

Constant Field Values

sourceFileDescriptors_

private java.util.List<DescriptorProtos.FileDescriptorProto> sourceFileDescriptors_

COMPILER_VERSION_FIELD_NUMBER
```
public static final int COMPILER_VERSION_FIELD_NUMBER
```
See Also:

Constant Field Values

compilerVersion_

private PluginProtos.Version compilerVersion_

memoizedIsInitialized
```
private byte memoizedIsInitialized
```

DEFAULT_INSTANCE

private static final PluginProtos.CodeGeneratorRequest DEFAULT_INSTANCE

PARSER

private static final Parser<PluginProtos.CodeGeneratorRequest> PARSER

Constructor Detail

CodeGeneratorRequest

private CodeGeneratorRequest(GeneratedMessage.Builder<?> builder)

CodeGeneratorRequest
```
private CodeGeneratorRequest()
```

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Description copied from class: GeneratedMessage

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.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage

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:: getFileToGenerateList in interface PluginProtos.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:: getFileToGenerateCount in interface PluginProtos.CodeGeneratorRequestOrBuilder
Returns:: The count of fileToGenerate.

getFileToGenerate

public java.lang.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:: getFileToGenerate in interface PluginProtos.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:: getFileToGenerateBytes in interface PluginProtos.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:

hasParameter in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

Whether the parameter field is set.

getParameter
```
public java.lang.String getParameter()
```
```
 The generator parameter passed on the command-line.
 
```
optional string parameter = 2;
Specified by:

getParameter in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

The parameter.

getParameterBytes
```
public ByteString getParameterBytes()
```
```
 The generator parameter passed on the command-line.
 
```
optional string parameter = 2;
Specified by:

getParameterBytes in interface PluginProtos.CodeGeneratorRequestOrBuilder

Returns:

The bytes for parameter.

getProtoFileList

public java.util.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.

 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:: getProtoFileList in interface PluginProtos.CodeGeneratorRequestOrBuilder

getProtoFileOrBuilderList

public java.util.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.

 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:: getProtoFileOrBuilderList in interface PluginProtos.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:: getProtoFileCount in interface PluginProtos.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.

 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:: getProtoFile in interface PluginProtos.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.

 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:: getProtoFileOrBuilder in interface PluginProtos.CodeGeneratorRequestOrBuilder