org.pageseeder.xmldoclet.options.FilenameOption Maven / Gradle / Ivy

Go to download
package org.pageseeder.xmldoclet.options;

import jdk.javadoc.doclet.Reporter;

import java.util.Collections;
import java.util.List;

/**
 * Option to specify the filename of the output.
 *
 * Only used if single output.
 *
 * @see MultipleOption
 *
 * @author Christophe Lauret
 * @version 1.0
 */
public final class FilenameOption extends XMLDocletOptionBase {

  /**
   * The default filename for the output.
   */
  private static final String DEFAULT_FILENAME = "xmldoclet.xml";

  private String filename = DEFAULT_FILENAME;

  public FilenameOption(Reporter reporter) {
    super(reporter);
  }

  @Override
  public int getArgumentCount() {
    return 1;
  }

  @Override
  public String getDescription() {
    return "name of the file (used for single output only)";
  }

  @Override
  public Kind getKind() {
    return Kind.STANDARD;
  }

  @Override
  public List getNames() {
    return Collections.singletonList("-filename");
  }

  @Override
  public String getParameters() {
    return "";
  }

  @Override
  public boolean process(String option, List arguments) {
    this.filename = arguments.get(0);
    return true;
  }

  public String getFilename() {
    return this.filename;
  }

}