Constructor Detail

• @Deprecated @SuppressWarnings('UnnecessaryCast') ResolverFactoryRegistry(Project temporaryProjectReference)

  Create a registry of factories for locating executables

  deprecated:

  Parameters:

  temporaryProjectReference - Associated project for resolving path relative to the project directory. This instance is maintained as a reference, so this class is safe for usage with configuration cache.

• @SuppressWarnings('UnnecessaryCast') ResolverFactoryRegistry(ProjectOperations projectOperations)

  Create a registry of factories for locating executables

  Parameters:

  projectOperations - Associated project for resolving path relative to the project directory. This instance is maintained as a reference, so this class is safe for usage with configuration cache.

  Since:

  1.0

Method Detail

• String findValidKey(java.util.Map<String, Object> exe)

  Look for exactly one valid key in the supplied map.

  Parameters:

  exe - List of keys to search.

  Returns:

  The valid key

  Throws:

  ExecConfigurationException if no keys are valid, or more than one key is valid.

• ResolvableExecutable getResolvableExecutable(java.util.Map<String, Object> exe)

  Use a key-value approach to finding the exe. In the default implementation only path and search are supported as a declarative keys. Implementations should use registerExecutableKeyActions to add more keys.

  Parameters:

  exe - Key-value setting exe (with optional extra keys)

  Returns:

  A resolved exe

  Throws:

  ExecConfigurationException if no keys are valid, or more than one key is valid.

• @Override ResolvableExecutableType getResolvableExecutableType(java.util.Map<String, Object> exe)

  Lazy-evaluated description of the exe

  Parameters:

  exe - A map that contains items like version : '1.2.3' or search : 'doxygen'

  Returns:

  Lazy-evaluated description of the exe or null if not configured.

• void registerExecutableKeyActions(String key, ResolvedExecutableFactory factory)

  Register more ways of locating executables.

  Parameters:

  key - The key that is used to indicate the resolver method

  factory - A factory that will be called be the value associated with the key.

• void registerExecutableKeyActions(NamedResolvedExecutableFactory factory)

  Register more ways of locating executables.

  Parameters:

  factory - A factory that will be called be the value associated with the key.