com.senzing.cmdline.ParameterProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of senzing-commons Show documentation

Utility classes and functions common to multiple Senzing projects.

The newest version!

package com.senzing.cmdline;

import java.util.List;

public interface ParameterProcessor {
  /**
   * Converts the specified command-line {@link String} parameters to a
   * {@link CommandLineOption} into an {@link Object} or array of
   * {@link Object} instances and determines if the parameters appear valid.
   *
   * @param commandLineOption The {@link CommandLineOption} asssociated with
   *                          the parameters.
   *
   * @param params The {@link List} of {@link String} parameters.
   *
   * @return The {@link Object} or array of {@link Object} instances
   *         representing the processed parameters.
   *
   * @throws BadOptionParametersException If the parameter(s) to the option are
   *                                      illegal in some way.
   */
  Object process(CommandLineOption commandLineOption, List params)
    throws BadOptionParametersException;
}