Record Class CalleeRetention.Facts

java.lang.Object
java.lang.Record
org.ek9lang.compiler.support.retention.CalleeRetention.Facts
Record Components:
unknown - the callee declares unknown: nothing may be assumed about anything it is given
parameterNames - its declared parameters, in order
arguments - what becomes of each argument, by index
receiverKeptInto - the parameters the receiver (or a part of it) is kept into
receiverAmbient - the receiver is kept somewhere no argument names
resultAliasesReceiver - the result may be a view of the receiver (return <- receiver-interior, or the receiver itself, return <- receiver)
undeclaredExternResult - the result of an extern declaring nothing, able to reach a user object (D7')
declaresNothing - no RETAINS text at all - neither declared nor derived; what that means depends on the callee: the audited extern keeps nothing, a user constructor was never derived
Enclosing class:
CalleeRetention

public static record CalleeRetention.Facts(boolean unknown, List<String> parameterNames, List<CalleeRetention.Argument> arguments, List<String> receiverKeptInto, boolean receiverAmbient, boolean resultAliasesReceiver, boolean undeclaredExternResult, boolean declaresNothing) extends Record
The escape facts of one callee.
  • Constructor Details

    • Facts

      public Facts(boolean unknown, List<String> parameterNames, List<CalleeRetention.Argument> arguments, List<String> receiverKeptInto, boolean receiverAmbient, boolean resultAliasesReceiver, boolean undeclaredExternResult, boolean declaresNothing)
      Creates an instance of a Facts record class.
      Parameters:
      unknown - the value for the unknown record component
      parameterNames - the value for the parameterNames record component
      arguments - the value for the arguments record component
      receiverKeptInto - the value for the receiverKeptInto record component
      receiverAmbient - the value for the receiverAmbient record component
      resultAliasesReceiver - the value for the resultAliasesReceiver record component
      undeclaredExternResult - the value for the undeclaredExternResult record component
      declaresNothing - the value for the declaresNothing record component
  • Method Details

    • argument

      public CalleeRetention.Argument argument(int index)
      What becomes of the argument at index; a position the callee does not declare keeps nothing.
    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • unknown

      public boolean unknown()
      Returns the value of the unknown record component.
      Returns:
      the value of the unknown record component
    • parameterNames

      public List<String> parameterNames()
      Returns the value of the parameterNames record component.
      Returns:
      the value of the parameterNames record component
    • arguments

      public List<CalleeRetention.Argument> arguments()
      Returns the value of the arguments record component.
      Returns:
      the value of the arguments record component
    • receiverKeptInto

      public List<String> receiverKeptInto()
      Returns the value of the receiverKeptInto record component.
      Returns:
      the value of the receiverKeptInto record component
    • receiverAmbient

      public boolean receiverAmbient()
      Returns the value of the receiverAmbient record component.
      Returns:
      the value of the receiverAmbient record component
    • resultAliasesReceiver

      public boolean resultAliasesReceiver()
      Returns the value of the resultAliasesReceiver record component.
      Returns:
      the value of the resultAliasesReceiver record component
    • undeclaredExternResult

      public boolean undeclaredExternResult()
      Returns the value of the undeclaredExternResult record component.
      Returns:
      the value of the undeclaredExternResult record component
    • declaresNothing

      public boolean declaresNothing()
      Returns the value of the declaresNothing record component.
      Returns:
      the value of the declaresNothing record component