Package org.eclipse.xtext.xbase.typesystem.internal

Enum CandidateCompareResult

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CandidateCompareResult>
    public enum CandidateCompareResult
extends java.lang.Enum<CandidateCompareResult>
    The result of the comparison of two linking candidates.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AMBIGUOUS
      Indicates that both candidates are equally valid.
      EQUALLY_INVALID
      Indicates that both candidates are equally invalid.
      OTHER
      Indicates that the current candidate is worse than the other one.
      SUSPICIOUS_OTHER
      Indicates that the current candidate is worse than the other one due to less specific parameter types, but the other one is on a different implicit receiver than this one.
      THIS
      Indicates that the current candidate is a better match than the other one.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CandidateCompareResult valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CandidateCompareResult[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • THIS

        public static final CandidateCompareResult THIS
        Indicates that the current candidate is a better match than the other one.

      • OTHER

        public static final CandidateCompareResult OTHER
        Indicates that the current candidate is worse than the other one.

      • SUSPICIOUS_OTHER

        public static final CandidateCompareResult SUSPICIOUS_OTHER
        Indicates that the current candidate is worse than the other one due to less specific parameter types, but the other one is on a different implicit receiver than this one. This result may only be returned when the expected argument types are compared.

      • AMBIGUOUS

        public static final CandidateCompareResult AMBIGUOUS
        Indicates that both candidates are equally valid. The situation may be ambiguous.

      • EQUALLY_INVALID

        public static final CandidateCompareResult EQUALLY_INVALID
        Indicates that both candidates are equally invalid. Pick the first one.

    • Method Detail

      • values

        public static CandidateCompareResult[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (CandidateCompareResult c : CandidateCompareResult.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CandidateCompareResult valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null