com.senzing.cmdline.BadOptionParametersException 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;

/**
 * Thrown when the parameters specified for a {@link CommandLineOption} are not
 * valid.
 */
public class BadOptionParametersException extends SpecifiedOptionException {
  /**
   * The parameters that were specified (if any).
   */
  private List parameters;

  /**
   * Constructs with the specified parameters.
   *
   * @param source The {@link CommandLineSource} describing how the option
   *               was specified.
   * @param specifier The command-line flag or environment variable used to
   *                  specify the option, or null if specified as a
   *                  default value.
   * @param option The {@link CommandLineOption} that was missing required
   *               parameters.
   * @param params The {@link List} of parameters that were specified (if any).
   */
  public BadOptionParametersException(CommandLineSource source,
                                      CommandLineOption option,
                                      String            specifier,
                                      List      params)
  {
    super(source, option, specifier);
    this.parameters = (params == null) ? List.of() : List.copyOf(params);
  }

  /**
   * Constructs with the specified parameters.
   *
   * @param source The {@link CommandLineSource} describing how the option
   *               was specified.
   * @param option The {@link CommandLineOption} that was missing required
   *               parameters.
   * @param specifier The command-line flag or environment variable used to
   *                  specify the option, or null if specified as a
   *                  default value.
   * @param params The {@link List} of parameters that were specified (if any).
   *
   * @param message The message for the exception.
   */
  public BadOptionParametersException(CommandLineSource source,
                                      CommandLineOption option,
                                      String            specifier,
                                      List      params,
                                      String            message)
  {
    super(source, option, specifier, message);
    this.parameters = (params == null) ? List.of() : List.copyOf(params);
  }

  /**
   * Returns the unmodifiable {@link List} of parameters that were
   * specified for the {@linkplain #getOption() option} (if any).
   *
   * @return The unmodifiable {@link List} of parameters that were
   *         specified for the {@linkplain #getOption() option} (if any).
   */
  public List getParameters() {
    return this.parameters;
  }

  /**
   *
   */
}