com.google.protobuf.descriptor.SourceCodeInfo

Location

final case class Location(path: Seq[Int] = scala.collection.Seq.empty[Nothing], span: Seq[Int] = scala.collection.Seq.empty[Nothing], leadingComments: Option[String] = scala.None, trailingComments: Option[String] = scala.None, leadingDetachedComments: Seq[String] = scala.collection.Seq.empty[Nothing]) extends trueaccord.scalapb.GeneratedMessage with trueaccord.scalapb.Message[Location] with Updatable[Location] with Product with Serializable

path

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. 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).

span

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.

leadingComments

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 qux. // // Another line attached to qux. optional double qux = 4;

// Detached comment for corge. This is not leading or trailing comments // to qux 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.

Annotations
@SerialVersionUID( 0L )
Linear Supertypes
Product, Equals, Updatable[Location], trueaccord.scalapb.Message[Location], trueaccord.scalapb.GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Location
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Location(path: Seq[Int] = scala.collection.Seq.empty[Nothing], span: Seq[Int] = scala.collection.Seq.empty[Nothing], leadingComments: Option[String] = scala.None, trailingComments: Option[String] = scala.None, leadingDetachedComments: Seq[String] = scala.collection.Seq.empty[Nothing])

    path

    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. 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).

    span

    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.

    leadingComments

    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 qux. // // Another line attached to qux. optional double qux = 4;

    // Detached comment for corge. This is not leading or trailing comments // to qux 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.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addAllLeadingDetachedComments(__vs: TraversableOnce[String]): Location

  7. def addAllPath(__vs: TraversableOnce[Int]): Location

  8. def addAllSpan(__vs: TraversableOnce[Int]): Location

  9. def addLeadingDetachedComments(__vs: String*): Location

  10. def addPath(__vs: Int*): Location

  11. def addSpan(__vs: Int*): Location

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def clearLeadingComments: Location

  14. def clearLeadingDetachedComments: Location

  15. def clearPath: Location

  16. def clearSpan: Location

  17. def clearTrailingComments: Location

  18. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def companion: Location.type

    Definition Classes
    LocationGeneratedMessage
  20. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def getField(__field: FieldDescriptor): PValue

    Definition Classes
    LocationGeneratedMessage
  24. def getFieldByNumber(__fieldNumber: Int): Any

    Definition Classes
    LocationGeneratedMessage
  25. def getLeadingComments: String

  26. def getTrailingComments: String

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. val leadingComments: Option[String]

    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.

    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 qux. // // Another line attached to qux. optional double qux = 4;

    // Detached comment for corge. This is not leading or trailing comments // to qux 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.

  29. val leadingDetachedComments: Seq[String]

  30. def mergeFrom(_input__: CodedInputStream): Location

    Definition Classes
    LocationMessage
  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  34. val path: Seq[Int]

    Identifies which part of the FileDescriptorProto was defined at this location.

    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. 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).

  35. final def serializedSize: Int

    Definition Classes
    LocationGeneratedMessage
  36. val span: Seq[Int]

    Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column.

    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.

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. def toByteArray: Array[Byte]

    Definition Classes
    GeneratedMessage
  39. def toByteString: ByteString

    Definition Classes
    GeneratedMessage
  40. def toPMessage: PMessage

    Definition Classes
    GeneratedMessage
  41. def toString(): String

    Definition Classes
    Location → AnyRef → Any
  42. val trailingComments: Option[String]

  43. def update(ms: (Lens[Location, Location]) ⇒ (Location) ⇒ Location*): Location

    Definition Classes
    Updatable
  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def withLeadingComments(__v: String): Location

  48. def withLeadingDetachedComments(__v: Seq[String]): Location

  49. def withPath(__v: Seq[Int]): Location

  50. def withSpan(__v: Seq[Int]): Location

  51. def withTrailingComments(__v: String): Location

  52. def writeDelimitedTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage
  53. def writeTo(_output__: CodedOutputStream): Unit

    Definition Classes
    LocationGeneratedMessage
  54. def writeTo(output: OutputStream): Unit

    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[Location]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped