Interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DescriptorProtos.SourceCodeInfo.Location, DescriptorProtos.SourceCodeInfo.Location.Builder
Enclosing class:
DescriptorProtos.SourceCodeInfo
public static interface DescriptorProtos.SourceCodeInfo.LocationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLeadingComments()
    If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.
    com.google.protobuf.ByteString
    getLeadingCommentsBytes()
    If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.
    String
    getLeadingDetachedComments(int index)
    repeated string leading_detached_comments = 6;
    com.google.protobuf.ByteString
    getLeadingDetachedCommentsBytes(int index)
    repeated string leading_detached_comments = 6;
    int
    getLeadingDetachedCommentsCount()
    repeated string leading_detached_comments = 6;
    List<String>
    getLeadingDetachedCommentsList()
    repeated string leading_detached_comments = 6;
    int
    getPath(int index)
    Identifies which part of the FileDescriptorProto was defined at this location.
    int
    getPathCount()
    Identifies which part of the FileDescriptorProto was defined at this location.
    List<Integer>
    getPathList()
    Identifies which part of the FileDescriptorProto was defined at this location.
    int
    getSpan(int index)
    Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.
    int
    getSpanCount()
    Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.
    List<Integer>
    getSpanList()
    Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.
    String
    getTrailingComments()
    optional string trailing_comments = 4;
    com.google.protobuf.ByteString
    getTrailingCommentsBytes()
    optional string trailing_comments = 4;
    boolean
    hasLeadingComments()
    If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.
    boolean
    hasTrailingComments()
    optional string trailing_comments = 4;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPathList

      List<Integer> getPathList()
       Identifies which part of the FileDescriptorProto was defined at this
 location.

 Each element is a field number or an index.  They form a path from
 the root FileDescriptorProto to the place where the definition appears.
 For example, this path:
 [ 4, 3, 2, 7, 1 ]
 refers to:
 file.message_type(3)  // 4, 3
 .field(7)         // 2, 7
 .name()           // 1
 This is because FileDescriptorProto.message_type has field number 4:
 repeated DescriptorProto message_type = 4;
 and DescriptorProto.field has field number 2:
 repeated FieldDescriptorProto field = 2;
 and FieldDescriptorProto.name has field number 1:
 optional string name = 1;

 Thus, the above path gives the location of a field name.  If we removed
 the last element:
 [ 4, 3, 2, 7 ]
 this path refers to the whole field declaration (from the beginning
 of the label to the terminating semicolon).
      repeated int32 path = 1 [packed = true];
      Returns:
      A list containing the path.

    • getPathCount

      int getPathCount()
       Identifies which part of the FileDescriptorProto was defined at this
 location.

 Each element is a field number or an index.  They form a path from
 the root FileDescriptorProto to the place where the definition appears.
 For example, this path:
 [ 4, 3, 2, 7, 1 ]
 refers to:
 file.message_type(3)  // 4, 3
 .field(7)         // 2, 7
 .name()           // 1
 This is because FileDescriptorProto.message_type has field number 4:
 repeated DescriptorProto message_type = 4;
 and DescriptorProto.field has field number 2:
 repeated FieldDescriptorProto field = 2;
 and FieldDescriptorProto.name has field number 1:
 optional string name = 1;

 Thus, the above path gives the location of a field name.  If we removed
 the last element:
 [ 4, 3, 2, 7 ]
 this path refers to the whole field declaration (from the beginning
 of the label to the terminating semicolon).
      repeated int32 path = 1 [packed = true];
      Returns:
      The count of path.

    • getPath

      int getPath(int index)
       Identifies which part of the FileDescriptorProto was defined at this
 location.

 Each element is a field number or an index.  They form a path from
 the root FileDescriptorProto to the place where the definition appears.
 For example, this path:
 [ 4, 3, 2, 7, 1 ]
 refers to:
 file.message_type(3)  // 4, 3
 .field(7)         // 2, 7
 .name()           // 1
 This is because FileDescriptorProto.message_type has field number 4:
 repeated DescriptorProto message_type = 4;
 and DescriptorProto.field has field number 2:
 repeated FieldDescriptorProto field = 2;
 and FieldDescriptorProto.name has field number 1:
 optional string name = 1;

 Thus, the above path gives the location of a field name.  If we removed
 the last element:
 [ 4, 3, 2, 7 ]
 this path refers to the whole field declaration (from the beginning
 of the label to the terminating semicolon).
      repeated int32 path = 1 [packed = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The path at the given index.

    • getSpanList

      List<Integer> getSpanList()
       Always has exactly three or four elements: start line, start column,
 end line (optional, otherwise assumed same as start line), end column.
 These are packed into a single field for efficiency.  Note that line
 and column numbers are zero-based -- typically you will want to add
 1 to each before displaying to a user.
      repeated int32 span = 2 [packed = true];
      Returns:
      A list containing the span.

    • getSpanCount

      int getSpanCount()
       Always has exactly three or four elements: start line, start column,
 end line (optional, otherwise assumed same as start line), end column.
 These are packed into a single field for efficiency.  Note that line
 and column numbers are zero-based -- typically you will want to add
 1 to each before displaying to a user.
      repeated int32 span = 2 [packed = true];
      Returns:
      The count of span.

    • getSpan

      int getSpan(int index)
       Always has exactly three or four elements: start line, start column,
 end line (optional, otherwise assumed same as start line), end column.
 These are packed into a single field for efficiency.  Note that line
 and column numbers are zero-based -- typically you will want to add
 1 to each before displaying to a user.
      repeated int32 span = 2 [packed = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The span at the given index.

    • hasLeadingComments

      boolean hasLeadingComments()
       If this SourceCodeInfo represents a complete declaration, these are any
 comments appearing before and after the declaration which appear to be
 attached to the declaration.

 A series of line comments appearing on consecutive lines, with no other
 tokens appearing on those lines, will be treated as a single comment.

 leading_detached_comments will keep paragraphs of comments that appear
 before (but not connected to) the current element. Each paragraph,
 separated by empty lines, will be one comment element in the repeated
 field.

 Only the comment content is provided; comment markers (e.g. //) are
 stripped out.  For block comments, leading whitespace and an asterisk
 will be stripped from the beginning of each line other than the first.
 Newlines are included in the output.

 Examples:

 optional int32 foo = 1;  // Comment attached to foo.
 // Comment attached to bar.
 optional int32 bar = 2;

 optional string baz = 3;
 // Comment attached to baz.
 // Another line attached to baz.

 // Comment attached to moo.
 //
 // Another line attached to moo.
 optional double moo = 4;

 // Detached comment for corge. This is not leading or trailing comments
 // to moo or corge because there are blank lines separating it from
 // both.

 // Detached comment for corge paragraph 2.

 optional string corge = 5;
 /* Block comment attached
 * to corge.  Leading asterisks
 * will be removed. */
 /* Block comment attached to
 * grault. */
 optional int32 grault = 6;

 // ignored detached comments.
      optional string leading_comments = 3;
      Returns:
      Whether the leadingComments field is set.

    • getLeadingComments

      String getLeadingComments()
       If this SourceCodeInfo represents a complete declaration, these are any
 comments appearing before and after the declaration which appear to be
 attached to the declaration.

 A series of line comments appearing on consecutive lines, with no other
 tokens appearing on those lines, will be treated as a single comment.

 leading_detached_comments will keep paragraphs of comments that appear
 before (but not connected to) the current element. Each paragraph,
 separated by empty lines, will be one comment element in the repeated
 field.

 Only the comment content is provided; comment markers (e.g. //) are
 stripped out.  For block comments, leading whitespace and an asterisk
 will be stripped from the beginning of each line other than the first.
 Newlines are included in the output.

 Examples:

 optional int32 foo = 1;  // Comment attached to foo.
 // Comment attached to bar.
 optional int32 bar = 2;

 optional string baz = 3;
 // Comment attached to baz.
 // Another line attached to baz.

 // Comment attached to moo.
 //
 // Another line attached to moo.
 optional double moo = 4;

 // Detached comment for corge. This is not leading or trailing comments
 // to moo or corge because there are blank lines separating it from
 // both.

 // Detached comment for corge paragraph 2.

 optional string corge = 5;
 /* Block comment attached
 * to corge.  Leading asterisks
 * will be removed. */
 /* Block comment attached to
 * grault. */
 optional int32 grault = 6;

 // ignored detached comments.
      optional string leading_comments = 3;
      Returns:
      The leadingComments.

    • getLeadingCommentsBytes

      com.google.protobuf.ByteString getLeadingCommentsBytes()
       If this SourceCodeInfo represents a complete declaration, these are any
 comments appearing before and after the declaration which appear to be
 attached to the declaration.

 A series of line comments appearing on consecutive lines, with no other
 tokens appearing on those lines, will be treated as a single comment.

 leading_detached_comments will keep paragraphs of comments that appear
 before (but not connected to) the current element. Each paragraph,
 separated by empty lines, will be one comment element in the repeated
 field.

 Only the comment content is provided; comment markers (e.g. //) are
 stripped out.  For block comments, leading whitespace and an asterisk
 will be stripped from the beginning of each line other than the first.
 Newlines are included in the output.

 Examples:

 optional int32 foo = 1;  // Comment attached to foo.
 // Comment attached to bar.
 optional int32 bar = 2;

 optional string baz = 3;
 // Comment attached to baz.
 // Another line attached to baz.

 // Comment attached to moo.
 //
 // Another line attached to moo.
 optional double moo = 4;

 // Detached comment for corge. This is not leading or trailing comments
 // to moo or corge because there are blank lines separating it from
 // both.

 // Detached comment for corge paragraph 2.

 optional string corge = 5;
 /* Block comment attached
 * to corge.  Leading asterisks
 * will be removed. */
 /* Block comment attached to
 * grault. */
 optional int32 grault = 6;

 // ignored detached comments.
      optional string leading_comments = 3;
      Returns:
      The bytes for leadingComments.

    • hasTrailingComments

      boolean hasTrailingComments()
      optional string trailing_comments = 4;
      Returns:
      Whether the trailingComments field is set.

    • getTrailingComments

      String getTrailingComments()
      optional string trailing_comments = 4;
      Returns:
      The trailingComments.

    • getTrailingCommentsBytes

      com.google.protobuf.ByteString getTrailingCommentsBytes()
      optional string trailing_comments = 4;
      Returns:
      The bytes for trailingComments.

    • getLeadingDetachedCommentsList

      List<String> getLeadingDetachedCommentsList()
      repeated string leading_detached_comments = 6;
      Returns:
      A list containing the leadingDetachedComments.

    • getLeadingDetachedCommentsCount

      int getLeadingDetachedCommentsCount()
      repeated string leading_detached_comments = 6;
      Returns:
      The count of leadingDetachedComments.

    • getLeadingDetachedComments

      String getLeadingDetachedComments(int index)
      repeated string leading_detached_comments = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The leadingDetachedComments at the given index.

    • getLeadingDetachedCommentsBytes

      com.google.protobuf.ByteString getLeadingDetachedCommentsBytes(int index)
      repeated string leading_detached_comments = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the leadingDetachedComments at the given index.