Class ArgumentList

Method Details

• fromArray

  public static ArgumentList fromArray(FunctionArgument... functionArguments)

• fromStruct

  public static ArgumentList fromStruct(Struct struct)

• anonymous

  public static ArgumentList anonymous(List<Type> argTypes)

  Returns:

  an ArgumentList from an anonymous list of types

• create

  public static ArgumentList create(String kw0, Type t0)

  Create an unary argument list. Shorthand for ArgumentList.fromArray(new FunctionArgument(kw0, arg0)).

• create

  public static ArgumentList create(String kw0, Type t0, String kw1, Type t1)

  Create a binary argument list. Shorthand for ArgumentList.fromArray(new FunctionArgument(kw0, arg0), ...).

• create

  public static ArgumentList create(String kw0, Type t0, String kw1, Type t1, String kw2, Type t2)

  Create a ternary argument list. Shorthand for ArgumentList.fromArray(new FunctionArgument(kw0, arg0), ...).

• create

  public static ArgumentList create(String kw0, Type t0, String kw1, Type t1, String kw2, Type t2, String kw3, Type t3)

  Create a quarternary argument list. Shorthand for ArgumentList.fromArray(new FunctionArgument(kw0, arg0), ...).

• get

  public FunctionArgument get(int index)

  Specified by:

  get in interface List<FunctionArgument>

  Specified by:

  get in class AbstractList<FunctionArgument>

• size

  public int size()

  Specified by:

  size in interface Collection<FunctionArgument>

  Specified by:

  size in interface List<FunctionArgument>

  Specified by:

  size in class AbstractCollection<FunctionArgument>

  Returns:

  the maximum number of arguments accepted (including any optional/nullable ones)

• getArity

  public com.google.common.collect.Range<Integer> getArity()

  Returns:

  the range of arguments accepted. The lower bound includes only the required arguments, and the upper bound includes any optional (nullable) arguments

• get

  public FunctionArgument get(String keyword)

• hasArgument

  public boolean hasArgument(String keyword)

• getKeywords

  public List<String> getKeywords()

• getArgumentTypes

  public List<Type> getArgumentTypes()

• getArgument

  public Optional<FunctionCall.Argument> getArgument(FunctionCall fc, String keywordName)

  Returns the FunctionCall FunctionCall.Argument (i.e. the actual value passed to the function), as opposed to the FunctionArgument (i.e. the placeholder).

• getRequiredArgument

  public ResultOrProblems<FunctionCall.Argument> getRequiredArgument(FunctionCall fc, String keyword)

• getRequiredAs

  public <T extends Type> ResultOrProblems<T> getRequiredAs(List<Type> givenTypes, int argIndex, Class<T> requiredType)

  Returns:

  the actual type of the argument provided by the user, or an appropriate error if it doesn't match what was expected.

• evaluateConstant

  @Deprecated public <T> ResultOrProblems<T> evaluateConstant(RealizationContext context, FunctionCall functionCall, String keyword, Class<T> requiredJavaType, Type requiredType)

  Deprecated.

  Use FunctionArgument.evaluateConstant(RealizationContext, FunctionCall, Class) instead

• isCompatible

  public boolean isCompatible(RealizationContext context, List<Type> givenTypes)

  Returns:

  true if the given types are compatible with these arguments (i.e. can be realized), false if not

• withExtraArgument

  public ArgumentList withExtraArgument(String keyword, Type type)

  Convenience version of that accepts the keyword and type of the extra argument</p>

  Parameters:

  keyword - the keyword for the extra argument

  type - the type of the extra argument

  Returns:

  new argument list

• withExtraArgument

  public ArgumentList withExtraArgument(FunctionArgument... extraArgs)

  Return a new argument list which has the same arguments has this one but with extraArg appended.

  Parameters:

  extraArgs - extra arguments to append to the new argument list

  Returns:

  new argument list

• getProblems

  public List<Problem> getProblems(RealizationContext context, List<Type> givenArgs)

  Returns:

  A list of problems from realization against the given types, or an empty list if there are no problems

• getProblems

  public List<Problem> getProblems(RealizationContext context, List<Type> givenArgs, BiFunction<FunctionArgument,Type,List<Problem>> describeMismatch)

  Same as getProblems(RealizationContext, List) except it lets you customize how argument/type mismatches are reported