Record Class ApiDiff

java.lang.Object
java.lang.Record
com.google.errorprone.bugpatterns.apidiff.ApiDiff
Record Components:
unsupportedClasses - Binary names of classes only present in the new API.
unsupportedMembersByClass - Members only present in the new API, grouped by binary name of their declaring class.
public record ApiDiff(com.google.common.collect.ImmutableSet<String> unsupportedClasses, com.google.common.collect.ImmutableSetMultimap<String, ApiDiff.ClassMemberKey> unsupportedMembersByClass) extends Record
The difference between two APIs.

  • Constructor Details

    • ApiDiff

      public ApiDiff(com.google.common.collect.ImmutableSet<String> unsupportedClasses, com.google.common.collect.ImmutableSetMultimap<String, ApiDiff.ClassMemberKey> unsupportedMembersByClass)
      Creates an instance of a ApiDiff record class.
      Parameters:
      unsupportedClasses - the value for the unsupportedClasses record component
      unsupportedMembersByClass - the value for the unsupportedMembersByClass record component

  • Method Details

    • fromMembers

      public static ApiDiff fromMembers(Set<String> unsupportedClasses, com.google.common.collect.Multimap<String, ApiDiff.ClassMemberKey> unsupportedMembersByClass)

    • fromProto

      public static ApiDiff fromProto(ApiDiffProto.Diff diff)
      Converts a ApiDiffProto.Diff to a ApiDiff.

    • toProto

      public ApiDiffProto.Diff toProto()
      Converts a ApiDiff to a ApiDiffProto.Diff.

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

    • unsupportedClasses

      public com.google.common.collect.ImmutableSet<String> unsupportedClasses()
      Returns the value of the unsupportedClasses record component.
      Returns:
      the value of the unsupportedClasses record component

    • unsupportedMembersByClass

      public com.google.common.collect.ImmutableSetMultimap<String, ApiDiff.ClassMemberKey> unsupportedMembersByClass()
      Returns the value of the unsupportedMembersByClass record component.
      Returns:
      the value of the unsupportedMembersByClass record component