Package io.codemodder

Record Class SourceCodeRegion

java.lang.Object
java.lang.Record
io.codemodder.SourceCodeRegion
public record SourceCodeRegion(Position start, Position end) extends Record
Describes a region of source code.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SourceCodeRegion(Position start, Position end)
    Creates an instance of a SourceCodeRegion record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Position
    end()
    Returns the value of the end record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static SourceCodeRegion
    fromSarif(com.contrastsecurity.sarif.Region region)
    Translate the SARIF model into the common model.
    final int
    hashCode()
    Returns a hash code value for this object.
    Position
    start()
    Returns the value of the start record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SourceCodeRegion

      public SourceCodeRegion(Position start, Position end)
      Creates an instance of a SourceCodeRegion record class.
      Parameters:
      start - the value for the start record component
      end - the value for the end record component

  • Method Details

    • fromSarif

      public static SourceCodeRegion fromSarif(com.contrastsecurity.sarif.Region region)
      Translate the SARIF model into the common model.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • start

      public Position start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public Position end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component