Method Detail

• args

  public static Object[] args(Object[] latter,
                              Object... former)

• inputs

  public static List<ModuleItem<?>> inputs(ModuleInfo info)

  Gets the given ModuleInfo's list of inputs, excluding special ones like Services and Contexts.

• outputs

  public static List<ModuleItem<?>> outputs(ModuleInfo info)

  Gets the given ModuleInfo's list of outputs.

• getNamespace

  public static String getNamespace(String opName)

  Gets the namespace portion of the given op name.

• stripNamespace

  public static String stripNamespace(String opName)

  Gets the simple portion (without namespace) of the given op name.

• unwrap

  public static Op unwrap(Module module,
                          OpRef ref)

  Unwraps the delegate object of the given Module, ensuring it is an instance whose type matches the specified OpRef.

  Parameters:

  module - The module to unwrap.

  ref - The OpRef defining the op's type restrictions.

  Returns:

  The unwrapped Op.

  Throws:

  IllegalStateException - if the op does not conform to the expected types.

• unwrap

  public static Op unwrap(Module module,
                          Collection<? extends Type> types)

  Unwraps the delegate object of the given Module, ensuring it is an instance of the specified type(s).

  Parameters:

  module - The module to unwrap.

  types - Required types for the op.

  Returns:

  The unwrapped Op.

  Throws:

  IllegalStateException - if the op does not conform to the expected types.

• opString

  public static String opString(String name,
                                Object... args)

  Gets a string describing the given op request.

  Parameters:

  name - The op's name.

  args - The op's input arguments.

  Returns:

  A string describing the op request.

• opString

  public static String opString(ModuleInfo info)

  Gets a string describing the given op.

  Parameters:

  info - The ModuleInfo metadata which describes the op.

  Returns:

  A string describing the op.

• opString

  public static String opString(ModuleInfo info,
                                ModuleItem<?> special)

  Gets a string describing the given op, highlighting the specific parameter.

  Parameters:

  info - The ModuleInfo metadata which describes the op.

  special - A parameter of particular interest when describing the op.

  Returns:

  A string describing the op.

• simpleString

  public static String simpleString(CommandInfo info)

  Similar to opString(ModuleInfo) but prints a cleaner, more abstract representation of the Op method call in the format return <= baseOp(param1, param2). Intended to be presented to users as the limited information reduces utility for debugging.

• opCall

  public static String opCall(CommandInfo info)

  Returns a method call for the given Op using its name and the correct count of parameters. Assumes the op will be called via an OpService of the name "ops".

• matchInfo

  public static String matchInfo(List<OpCandidate> candidates,
                                 List<OpCandidate> matches)

  Gets a string with an analysis of a particular match request failure.

  This method is used to generate informative exception messages when no matches, or too many matches, are found.

  Parameters:

  candidates - The list of already-analyzed candidates from which a match was desired.

  matches - The list of matching candidates with attached Module instances.

  Returns:

  A multi-line string describing the situation: 1) the type of match failure; 2) the list of matching ops (if any); 3) the request itself; and 4) the list of candidates including status (i.e., whether it matched, and if not, why not).

  See Also:

  OpMatchingService.filterMatches(List)

• getOpName

  public static String getOpName(CommandInfo info)

  Gets the string name of an op.