com.senzing.cmdline.CommandLineParser 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;
import java.util.Map;

/**
 * Provides an interface for parsing the command line.
 */
public interface CommandLineParser {
  /**
   * Implement this method to parse the command line arguments and produce a
   * {@link Map} of {@link CommandLineOption} keys to {@link Object} values.
   *
   * @param args The command-line arguments to parse.
   *
   * @param deprecationWarnings The {@link List} to be populated with any
   *                            {@link DeprecatedOptionWarning} instances that
   *                            are generated, or null if the
   *                            caller is not interested in deprecation
   *                            warnings.
   *
   * @return The {@link Map} of {@link CommandLineOption} keys to {@link Object}
   *         values describing the provided arguments.
   *
   * @throws CommandLineException If a command-line parsing/proecesing error
   *                              occurs.
   */
  Map parseCommandLine(
      String[]                      args,
      List deprecationWarnings)
    throws CommandLineException;
}