com.github.cukedoctor.api.CukedoctorConverter Maven / Gradle / Ivy

Go to download
package com.github.cukedoctor.api;

import com.github.cukedoctor.api.model.Feature;
import java.util.List;

/** Created by pestano on 02/06/15. */
public interface CukedoctorConverter {

  DocumentAttributes getDocumentAttributes();

  List getFeatures();

  String getDocumentation();

  /** @return a string representation of the current document in Asciidoctor format */
  String renderDocumentation();

  String getDocumentationTitle();

  /**
   * @param features the features to render
   * @return underlying Converter instance
   * @deprecated Use an appropriate instance of FeatureRenderer to render the document features only
   *     e.g. CukedoctorFeatureRenderer
   */
  @Deprecated
  CukedoctorConverter renderFeatures(List features);

  /**
   * @return underlying Converter instance
   * @deprecated Use an appropriate instance of FeatureRenderer to render the document features only
   *     e.g. CukedoctorFeatureRenderer
   */
  @Deprecated
  CukedoctorConverter renderFeatures();

  /**
   * @return underlying Converter instance
   * @deprecated Use an appropriate instance of HeaderRenderer to render the document attributes
   *     only e.g. CukedoctorHeaderRenderer
   */
  @Deprecated
  CukedoctorConverter renderAttributes();

  /**
   * @deprecated Use an appropriate instance of SummaryRenderer to render the document summary only
   *     e.g. CukedoctorSummaryRenderer
   * @return underlying Converter instance
   */
  @Deprecated
  CukedoctorConverter renderSummary();

  /**
   * set output file name without extension (should always be .adoc or other asciidoc compatible
   * extensions) If no filename is set then Documentation title (first H1 section) will be used as
   * filename (underline will be used to remove spaces) The filename is used mainly for asciidoc
   * docinfo creation.
   *
   * @param filename name to be set
   * @return underlying Converter instance
   */
  CukedoctorConverter setFilename(String filename);

  String getFilename();

  CukedoctorConverter addCustomCss();

  CukedoctorConverter addCustomPdfTheme();

  /**
   * Saves the documentation into disk using {@link CukedoctorConverter#getFilename()} as name (also
   * path). Note that
   *
   * @see CukedoctorConverter#renderDocumentation() will be called and used as content to save the
   *     file.
   * @return underlying Converter instance
   */
  CukedoctorConverter saveDocumentation();
}