public static final class PluginProtos.CodeGeneratorResponse extends GeneratedMessageV3 implements PluginProtos.CodeGeneratorResponseOrBuilder
The plugin writes an encoded CodeGeneratorResponse to stdout.
Protobuf type google.protobuf.compiler.CodeGeneratorResponse
Static Fields
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILE_FIELD_NUMBER
public static final int FILE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARSER
public static final Parser<PluginProtos.CodeGeneratorResponse> PARSER
SUPPORTED_FEATURES_FIELD_NUMBER
public static final int SUPPORTED_FEATURES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PluginProtos.CodeGeneratorResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PluginProtos.CodeGeneratorResponse.Builder newBuilder()
newBuilder(PluginProtos.CodeGeneratorResponse prototype)
public static PluginProtos.CodeGeneratorResponse.Builder newBuilder(PluginProtos.CodeGeneratorResponse prototype)
public static PluginProtos.CodeGeneratorResponse parseDelimitedFrom(InputStream input)
public static PluginProtos.CodeGeneratorResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PluginProtos.CodeGeneratorResponse parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PluginProtos.CodeGeneratorResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorResponse parseFrom(CodedInputStream input)
public static PluginProtos.CodeGeneratorResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorResponse parseFrom(InputStream input)
public static PluginProtos.CodeGeneratorResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PluginProtos.CodeGeneratorResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PluginProtos.CodeGeneratorResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PluginProtos.CodeGeneratorResponse> 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
getDefaultInstanceForType()
public PluginProtos.CodeGeneratorResponse 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.
getError()
Error message. If non-empty, code generation failed. The plugin process
should exit with status code zero even if it reports an error in this way.
This should be used to indicate errors in .proto files which prevent the
code generator from generating correct code. Errors which indicate a
problem in protoc itself -- such as the input CodeGeneratorRequest being
unparseable -- should be reported by writing a message to stderr and
exiting with a non-zero status code.
optional string error = 1;
| Returns |
|---|
| Type | Description |
String | The error.
|
getErrorBytes()
public ByteString getErrorBytes()
Error message. If non-empty, code generation failed. The plugin process
should exit with status code zero even if it reports an error in this way.
This should be used to indicate errors in .proto files which prevent the
code generator from generating correct code. Errors which indicate a
problem in protoc itself -- such as the input CodeGeneratorRequest being
unparseable -- should be reported by writing a message to stderr and
exiting with a non-zero status code.
optional string error = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for error.
|
getFile(int index)
public PluginProtos.CodeGeneratorResponse.File getFile(int index)
repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;
| Parameter |
|---|
| Name | Description |
index | int
|
getFileCount()
public int getFileCount()
repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;
| Returns |
|---|
| Type | Description |
int | |
getFileList()
public List<PluginProtos.CodeGeneratorResponse.File> getFileList()
repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;
getFileOrBuilder(int index)
public PluginProtos.CodeGeneratorResponse.FileOrBuilder getFileOrBuilder(int index)
repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;
| Parameter |
|---|
| Name | Description |
index | int
|
getFileOrBuilderList()
public List<? extends PluginProtos.CodeGeneratorResponse.FileOrBuilder> getFileOrBuilderList()
repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15;
| Returns |
|---|
| Type | Description |
List<? extends com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponse.FileOrBuilder> | |
getParserForType()
public Parser<PluginProtos.CodeGeneratorResponse> getParserForType()
Overrides
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
getSupportedFeatures()
public long getSupportedFeatures()
A bitmask of supported features that the code generator supports.
This is a bitwise "or" of values from the Feature enum.
optional uint64 supported_features = 2;
| Returns |
|---|
| Type | Description |
long | The supportedFeatures.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasError()
public boolean hasError()
Error message. If non-empty, code generation failed. The plugin process
should exit with status code zero even if it reports an error in this way.
This should be used to indicate errors in .proto files which prevent the
code generator from generating correct code. Errors which indicate a
problem in protoc itself -- such as the input CodeGeneratorRequest being
unparseable -- should be reported by writing a message to stderr and
exiting with a non-zero status code.
optional string error = 1;
| Returns |
|---|
| Type | Description |
boolean | Whether the error field is set.
|
hasSupportedFeatures()
public boolean hasSupportedFeatures()
A bitmask of supported features that the code generator supports.
This is a bitwise "or" of values from the Feature enum.
optional uint64 supported_features = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the supportedFeatures 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.CodeGeneratorResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PluginProtos.CodeGeneratorResponse.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.CodeGeneratorResponse.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.
