Package org.sonar.python.types.v2

Record Class UnionType

java.lang.Object
java.lang.Record
org.sonar.python.types.v2.UnionType
All Implemented Interfaces:
PythonType
@Beta public record UnionType(Set<PythonType> candidates) extends Record implements PythonType

  • Constructor Details

    • UnionType

      public UnionType(Set<PythonType> candidates)
      Creates an instance of a UnionType record class.
      Parameters:
      candidates - the value for the candidates record component

  • Method Details

    • displayName

      public Optional<String> displayName()
      Specified by:
      displayName in interface PythonType

    • hasMember

      public TriBool hasMember(String memberName)
      For UnionType, hasMember will return true if all alternatives have the member It will return false if all alternatives DON'T have the member It will return unknown in all other cases
      Specified by:
      hasMember in interface PythonType

    • isCompatibleWith

      public boolean isCompatibleWith(PythonType another)
      Specified by:
      isCompatibleWith in interface PythonType

    • or

      @Beta public static PythonType or(Collection<PythonType> candidates)

    • or

      @Beta public static PythonType or(PythonType type1, PythonType type2)

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

    • candidates

      public Set<PythonType> candidates()
      Returns the value of the candidates record component.
      Returns:
      the value of the candidates record component