Record Class ThreadSafety.Violation

java.lang.Object
java.lang.Record
com.google.errorprone.bugpatterns.threadsafety.ThreadSafety.Violation
Record Components:
path - The list of steps in the explanation.

Example: ["Foo has field 'xs' of type 'int[]'", "arrays are not thread-safe"]

Enclosing class:
ThreadSafety
public static record ThreadSafety.Violation(org.pcollections.ConsPStack<String> path) extends Record
A human-friendly explanation of a thread safety violations.

An absent explanation indicates either an annotated type with no violations, or a type without the annotation.

  • Constructor Details

    • Violation

      public Violation(org.pcollections.ConsPStack<String> path)
      Creates an instance of a Violation record class.
      Parameters:
      path - the value for the path record component

  • Method Details

    • create

      public static ThreadSafety.Violation create(org.pcollections.ConsPStack<String> path)

    • isPresent

      public boolean isPresent()
      Returns true if a violation was found.

    • message

      public String message()
      Returns the explanation.

    • plus

      public ThreadSafety.Violation plus(String edge)
      Adds a step.

    • of

      public static ThreadSafety.Violation of(String reason)
      Creates an explanation with one step.

    • absent

      public static ThreadSafety.Violation absent()
      An empty explanation.

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

    • path

      public org.pcollections.ConsPStack<String> path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component