com.exadatum.xsuite.xmaven.bash.doc.DocGeneratorContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bash-maven-plugin Show documentation

Bash Maven Plugin is used to generate documentation as well as to run unit test for bash scripts.

The newest version!

package com.exadatum.xsuite.xmaven.bash.doc;

import java.io.File;
import java.util.List;

/*-
 * #%L
 * Exadatum Bash Function Document Generator
 * %%
 * Copyright (C) 2016 - 2017 Exadatum Software Services Pvt. Ltd.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import org.apache.maven.doxia.sink.Sink;

/**
 * Context to hold all the information needed by documentation generator.
 */
public class DocGeneratorContext {

  /**
   * Maven Doxia API to produce a resultant output format.
   */
  private Sink sink;

  /**
   *
   * @return current Sink object.
   */
  public Sink getSink() {
    return sink;
  }

  /**
   * Setter for sink.
   *
   * @param sink
   */
  public void setSink(final Sink sink) {
    this.sink = sink;
  }

  /**
   * Page template to be used for document generation.
   */
  private File pageTemplate;

  /**
   * Output page to be generated.
   */
  private File outputPage;

  /**
   * Parsed documentation blocks.
   */
  private List docBlocks;

  /**
   * Getter for file name.
   *
   * @return file name.
   */
  public String getFileName() {
    return fileName;
  }

  /**
   * Setter for file name.
   *
   * @param fileName
   */
  public void setFileName(final String fileName) {
    this.fileName = fileName;
  }

  /**
   * Name of file for which document is to be generated.
   */
  private String fileName;

  /**
   * Getter for file pageTemplate.
   *
   * @return pageTemplate
   */
  public File getPageTemplate() {
    return pageTemplate;
  }

  /**
   * Setter for file pageTemplate.
   *
   * @param pageTemplate
   */
  public void setPageTemplate(final File pageTemplate) {
    this.pageTemplate = pageTemplate;
  }

  /**
   * Getter for file outputPage.
   *
   * @return outputPage
   */
  public File getOutputPage() {
    return outputPage;
  }

  /**
   * Setter for file outputPage.
   *
   * @param outputPage
   */
  public void setOutputPage(final File outputPage) {
    this.outputPage = outputPage;
  }

  /**
   * Getter for list of doc blocks.
   *
   * @return docBlocks
   */
  public List getDocBlocks() {
    return docBlocks;
  }

  /**
   * Setter for list of doc blocks.
   *
   * @param docBlocks
   */
  public void setDocBlocks(final List docBlocks) {
    this.docBlocks = docBlocks;
  }

}