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

/**
 * Represents a value obtained from the command-line parser for a given
 * {@link CommandLineOption}.
 */
public class CommandLineValue implements SpecifiedOption {
  /**
   * The option for this value.
   */
  private CommandLineOption option;

  /**
   * The {@link CommandLineSource} from whence the value came.
   */
  private CommandLineSource source;

  /**
   * The command-line flag or environment variable from which the value
   * was obtained if the source is not {@link CommandLineSource#DEFAULT}.
   */
  private String specifier;

  /**
   * The processed value for the option.
   */
  private Object processedValue;

  /**
   * The original text parameter values for the option.
   */
  private List parameters;

  /**
   * Constructs with the specified option, {@link CommandLineSource}, processed
   * value and {@link List} of {@link String} parameters that were used to
   * specify this option.
   *
   * @param source The {@link CommandLineSource} that represents the source of
   *               the value.
   * @param option The {@link CommandLineOption} that for with this value.
   * @param processedValue The processed value from the command-line parser.
   * @param parameters The {@link String} parameters used to specify this.
   */
  public CommandLineValue(CommandLineSource source,
                          CommandLineOption option,
                          Object            processedValue,
                          List      parameters)
  {
    this(source, option, null, processedValue, parameters);
  }

  /**
   * Constructs with the specified option, {@link CommandLineSource}, processed
   * value and {@link List} of {@link String} parameters that were used to
   * specify this option.
   *
   * @param source The {@link CommandLineSource} that represents the source of
   *               the value.
   * @param option The {@link CommandLineOption} that for with this value.
   * @param specifier The {@link String} specifier associated with the {@link
   *                  CommandLineSource} or null if it does not
   *                  apply.
   * @param processedValue The processed value from the command-line parser.
   * @param parameters The {@link String} parameters used to specify this.
   */
  public CommandLineValue(CommandLineSource source,
                          CommandLineOption option,
                          String            specifier,
                          Object            processedValue,
                          List      parameters)
  {
    this.option         = option;
    this.source         = source;
    this.specifier      = specifier;
    this.processedValue = processedValue;
    this.parameters     = List.copyOf(parameters);
  }

  /**
   * Gets the associated {@link CommandLineOption}.
   *
   * @return The associated {@link CommandLineOption}.
   */
  @Override
  public CommandLineOption getOption() {
    return this.option;
  }

  /**
   * Gets the associated {@link CommandLineSource}.
   *
   * @return The associated {@link CommandLineSource}.
   */
  @Override
  public CommandLineSource getSource() {
    return this.source;
  }

  /**
   * Sets the associated {@link CommandLineSource}.
   *
   * @param source The associated {@link CommandLineSource}.
   */
  public void setSource(CommandLineSource source) {
    this.source = source;
  }

  /**
   * Gets the specifier associated with the {@link CommandLineSource} (if any).
   * This returns null if none.
   *
   * @return The specifier associated with the {@link CommandLineSource}, or
   *         null if none.
   */
  @Override
  public String getSpecifier() {
    return this.specifier;
  }

  /**
   * Sets the specifier associated with the {@link CommandLineSource} (if any).
   * Set this to null if none.
   *
   * @param specifier The specifier associated with the {@link
   *                  CommandLineSource}, or null if none.
   */
  public void setSpecifier(String specifier) {
    this.specifier = specifier;
  }

  /**
   * Gets the processed value associated with the {@link CommandLineOption}.
   *
   * @return The processed value associated with the {@link CommandLineOption}.
   */
  public Object getProcessedValue() {
    return this.processedValue;
  }

  /**
   * Sets the processed value associated with the {@link CommandLineOption}.
   *
   * @param processedValue The processed value associated with the {@link
   *                       CommandLineOption}.
   */
  public void setProcessedValue(Object processedValue) {
    this.processedValue = processedValue;
  }

  /**
   * Gets the {@link List} of {@link String} parameters for this option.
   * These are the unprocessed parameter values that were passed.
   *
   * @return The {@link List} of {@link String} parameters for this option.
   */
  public List getParameters() {
    return this.parameters;
  }

  /**
   * Sets the {@link List} of {@link String} parameters for this option.
   * These are the unprocessed parameter values that were passed.
   *
   * @param parameters The {@link List} of {@link String} parameters for this
   *                   option.
   */
  public void setParameters(List parameters) {
    this.parameters = parameters;
  }

  /**
   * Returns a diagnostic {@link String} describing this instance.
   *
   * @return A diagnostic {@link String} describing this instance.
   */
  public String toString() {
    return ("{ option=[ " + this.getOption() + " ], processedValue=[ "
            + this.getProcessedValue() + " ], source=[ " + this.getSource()
            + " ], specifier=[ " + this.getSpecifier() + " ], parameters=[ "
            + this.getParameters() + " ] }");
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    CommandLineValue value = (CommandLineValue) o;

    return Objects.equals(this.getOption(), value.getOption())
        && this.getSource() == value.getSource()
        && Objects.equals(this.getSpecifier(), value.getSpecifier())
        && Objects.equals(this.getProcessedValue(), value.getProcessedValue())
        && Objects.equals(this.getParameters(), value.getParameters());
  }

  @Override
  public int hashCode() {
    return Objects.hash(this.getOption(),
                        this.getSource(),
                        this.getSpecifier(),
                        this.getProcessedValue(),
                        this.getParameters());
  }
}