Package com.google.protobuf.compiler

Class PluginProtos.CodeGeneratorResponse.File

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<PluginProtos.CodeGeneratorResponse.File,PluginProtos.CodeGeneratorResponse.File.Builder>
com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponse.File
All Implemented Interfaces:
PluginProtos.CodeGeneratorResponse.FileOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
Enclosing class:
PluginProtos.CodeGeneratorResponse
public static final class PluginProtos.CodeGeneratorResponse.File extends com.google.protobuf.GeneratedMessageLite<PluginProtos.CodeGeneratorResponse.File,PluginProtos.CodeGeneratorResponse.File.Builder> implements PluginProtos.CodeGeneratorResponse.FileOrBuilder
 Represents a single generated file.
Protobuf type google.protobuf.compiler.CodeGeneratorResponse.File

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • INSERTION_POINT_FIELD_NUMBER

      public static final int INSERTION_POINT_FIELD_NUMBER
      See Also:

    • CONTENT_FIELD_NUMBER

      public static final int CONTENT_FIELD_NUMBER
      See Also:

    • GENERATED_CODE_INFO_FIELD_NUMBER

      public static final int GENERATED_CODE_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • hasName

      public boolean hasName()
       The file name, relative to the output directory.  The name must not
 contain "." or ".." components and must be relative, not be absolute (so,
 the file cannot lie outside the output directory).  "/" must be used as
 the path separator, not "\".

 If the name is omitted, the content will be appended to the previous
 file.  This allows the generator to break large files into small chunks,
 and allows the generated text to be streamed back to protoc so that large
 files need not reside completely in memory at one time.  Note that as of
 this writing protoc does not optimize for this -- it will read the entire
 CodeGeneratorResponse before writing files to disk.
      optional string name = 1 [json_name = "name"];
      Specified by:
      hasName in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       The file name, relative to the output directory.  The name must not
 contain "." or ".." components and must be relative, not be absolute (so,
 the file cannot lie outside the output directory).  "/" must be used as
 the path separator, not "\".

 If the name is omitted, the content will be appended to the previous
 file.  This allows the generator to break large files into small chunks,
 and allows the generated text to be streamed back to protoc so that large
 files need not reside completely in memory at one time.  Note that as of
 this writing protoc does not optimize for this -- it will read the entire
 CodeGeneratorResponse before writing files to disk.
      optional string name = 1 [json_name = "name"];
      Specified by:
      getName in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The file name, relative to the output directory.  The name must not
 contain "." or ".." components and must be relative, not be absolute (so,
 the file cannot lie outside the output directory).  "/" must be used as
 the path separator, not "\".

 If the name is omitted, the content will be appended to the previous
 file.  This allows the generator to break large files into small chunks,
 and allows the generated text to be streamed back to protoc so that large
 files need not reside completely in memory at one time.  Note that as of
 this writing protoc does not optimize for this -- it will read the entire
 CodeGeneratorResponse before writing files to disk.
      optional string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The bytes for name.

    • hasInsertionPoint

      public boolean hasInsertionPoint()
       If non-empty, indicates that the named file should already exist, and the
 content here is to be inserted into that file at a defined insertion
 point.  This feature allows a code generator to extend the output
 produced by another code generator.  The original generator may provide
 insertion points by placing special annotations in the file that look
 like:
   @@protoc_insertion_point(NAME)
 The annotation can have arbitrary text before and after it on the line,
 which allows it to be placed in a comment.  NAME should be replaced with
 an identifier naming the point -- this is what other generators will use
 as the insertion_point.  Code inserted at this point will be placed
 immediately above the line containing the insertion point (thus multiple
 insertions to the same point will come out in the order they were added).
 The double-@ is intended to make it unlikely that the generated code
 could contain things that look like insertion points by accident.

 For example, the C++ code generator places the following line in the
 .pb.h files that it generates:
   // @@protoc_insertion_point(namespace_scope)
 This line appears within the scope of the file's package namespace, but
 outside of any particular class.  Another plugin can then specify the
 insertion_point "namespace_scope" to generate additional classes or
 other declarations that should be placed in this scope.

 Note that if the line containing the insertion point begins with
 whitespace, the same whitespace will be added to every line of the
 inserted text.  This is useful for languages like Python, where
 indentation matters.  In these languages, the insertion point comment
 should be indented the same amount as any inserted code will need to be
 in order to work correctly in that context.

 The code generator that generates the initial file and the one which
 inserts into it must both run as part of a single invocation of protoc.
 Code generators are executed in the order in which they appear on the
 command line.

 If |insertion_point| is present, |name| must also be present.
      optional string insertion_point = 2 [json_name = "insertionPoint"];
      Specified by:
      hasInsertionPoint in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      Whether the insertionPoint field is set.

    • getInsertionPoint

      public String getInsertionPoint()
       If non-empty, indicates that the named file should already exist, and the
 content here is to be inserted into that file at a defined insertion
 point.  This feature allows a code generator to extend the output
 produced by another code generator.  The original generator may provide
 insertion points by placing special annotations in the file that look
 like:
   @@protoc_insertion_point(NAME)
 The annotation can have arbitrary text before and after it on the line,
 which allows it to be placed in a comment.  NAME should be replaced with
 an identifier naming the point -- this is what other generators will use
 as the insertion_point.  Code inserted at this point will be placed
 immediately above the line containing the insertion point (thus multiple
 insertions to the same point will come out in the order they were added).
 The double-@ is intended to make it unlikely that the generated code
 could contain things that look like insertion points by accident.

 For example, the C++ code generator places the following line in the
 .pb.h files that it generates:
   // @@protoc_insertion_point(namespace_scope)
 This line appears within the scope of the file's package namespace, but
 outside of any particular class.  Another plugin can then specify the
 insertion_point "namespace_scope" to generate additional classes or
 other declarations that should be placed in this scope.

 Note that if the line containing the insertion point begins with
 whitespace, the same whitespace will be added to every line of the
 inserted text.  This is useful for languages like Python, where
 indentation matters.  In these languages, the insertion point comment
 should be indented the same amount as any inserted code will need to be
 in order to work correctly in that context.

 The code generator that generates the initial file and the one which
 inserts into it must both run as part of a single invocation of protoc.
 Code generators are executed in the order in which they appear on the
 command line.

 If |insertion_point| is present, |name| must also be present.
      optional string insertion_point = 2 [json_name = "insertionPoint"];
      Specified by:
      getInsertionPoint in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The insertionPoint.

    • getInsertionPointBytes

      public com.google.protobuf.ByteString getInsertionPointBytes()
       If non-empty, indicates that the named file should already exist, and the
 content here is to be inserted into that file at a defined insertion
 point.  This feature allows a code generator to extend the output
 produced by another code generator.  The original generator may provide
 insertion points by placing special annotations in the file that look
 like:
   @@protoc_insertion_point(NAME)
 The annotation can have arbitrary text before and after it on the line,
 which allows it to be placed in a comment.  NAME should be replaced with
 an identifier naming the point -- this is what other generators will use
 as the insertion_point.  Code inserted at this point will be placed
 immediately above the line containing the insertion point (thus multiple
 insertions to the same point will come out in the order they were added).
 The double-@ is intended to make it unlikely that the generated code
 could contain things that look like insertion points by accident.

 For example, the C++ code generator places the following line in the
 .pb.h files that it generates:
   // @@protoc_insertion_point(namespace_scope)
 This line appears within the scope of the file's package namespace, but
 outside of any particular class.  Another plugin can then specify the
 insertion_point "namespace_scope" to generate additional classes or
 other declarations that should be placed in this scope.

 Note that if the line containing the insertion point begins with
 whitespace, the same whitespace will be added to every line of the
 inserted text.  This is useful for languages like Python, where
 indentation matters.  In these languages, the insertion point comment
 should be indented the same amount as any inserted code will need to be
 in order to work correctly in that context.

 The code generator that generates the initial file and the one which
 inserts into it must both run as part of a single invocation of protoc.
 Code generators are executed in the order in which they appear on the
 command line.

 If |insertion_point| is present, |name| must also be present.
      optional string insertion_point = 2 [json_name = "insertionPoint"];
      Specified by:
      getInsertionPointBytes in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The bytes for insertionPoint.

    • hasContent

      public boolean hasContent()
       The file contents.
      optional string content = 15 [json_name = "content"];
      Specified by:
      hasContent in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public String getContent()
       The file contents.
      optional string content = 15 [json_name = "content"];
      Specified by:
      getContent in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The content.

    • getContentBytes

      public com.google.protobuf.ByteString getContentBytes()
       The file contents.
      optional string content = 15 [json_name = "content"];
      Specified by:
      getContentBytes in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The bytes for content.

    • hasGeneratedCodeInfo

      public boolean hasGeneratedCodeInfo()
       Information describing the file content being inserted. If an insertion
 point is used, this information will be appropriately offset and inserted
 into the code generation metadata for the generated files.
      optional .google.protobuf.GeneratedCodeInfo generated_code_info = 16 [json_name = "generatedCodeInfo"];
      Specified by:
      hasGeneratedCodeInfo in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      Whether the generatedCodeInfo field is set.

    • getGeneratedCodeInfo

      public DescriptorProtos.GeneratedCodeInfo getGeneratedCodeInfo()
       Information describing the file content being inserted. If an insertion
 point is used, this information will be appropriately offset and inserted
 into the code generation metadata for the generated files.
      optional .google.protobuf.GeneratedCodeInfo generated_code_info = 16 [json_name = "generatedCodeInfo"];
      Specified by:
      getGeneratedCodeInfo in interface PluginProtos.CodeGeneratorResponse.FileOrBuilder
      Returns:
      The generatedCodeInfo.

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PluginProtos.CodeGeneratorResponse.File parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PluginProtos.CodeGeneratorResponse.File parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PluginProtos.CodeGeneratorResponse.File parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static PluginProtos.CodeGeneratorResponse.File.Builder newBuilder()

    • newBuilder

      public static PluginProtos.CodeGeneratorResponse.File.Builder newBuilder(PluginProtos.CodeGeneratorResponse.File prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<PluginProtos.CodeGeneratorResponse.File,PluginProtos.CodeGeneratorResponse.File.Builder>

    • getDefaultInstance

      public static PluginProtos.CodeGeneratorResponse.File getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PluginProtos.CodeGeneratorResponse.File> parser()