Package org.asciidoctor

Interface Asciidoctor

All Superinterfaces:
AutoCloseable
All Known Subinterfaces:
AsciidoctorJRuby
All Known Implementing Classes:
JRubyAsciidoctor
public interface Asciidoctor extends AutoCloseable
The main application interface (API) for Asciidoctor. This API provides methods to:
  • parse (aka. load) AsciiDoc content,
  • convert it to various output formats,
  • register extensions, custom converter and syntax highlighter.

  • Method Details

    • convert

      @Deprecated String convert(String content, Map<String,Object> options)
      Deprecated.
      User convert(String, Options) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as String object.

      Parameters:
      content - the AsciiDoc source as String.
      options - a Map of options to control processing (default: {}).
      Returns:
      the rendered output String is returned

    • convert

      @Deprecated <T> T convert(String content, Map<String,Object> options, Class<T> expectedResult)
      Deprecated.
      Use convert(String, Options, Class) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as String object.

      Parameters:
      content - the AsciiDoc source as String.
      options - a Map of options to control processing (default: {}).
      expectedResult - the expected return type. Usually String for HTML based formats. In this case convert(String, Map) is the same.
      Returns:
      the rendered output String is returned

    • convert

      String convert(String content, Options options)
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as String object.

      Parameters:
      content - the AsciiDoc source as String.
      options - options to control processing (default: empty).
      Returns:
      the rendered output String is returned

    • convert

      <T> T convert(String content, Options options, Class<T> expectedResult)
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as String object.

      Parameters:
      content - the AsciiDoc source as String.
      options - options to control processing (default: empty).
      expectedResult - the expected return type. Usually String for HTML based formats. In this case convert(String, Options) is the same.
      Returns:
      the rendered output String is returned

    • convert

      @Deprecated String convert(String content, OptionsBuilder options)
      Deprecated.
      Use convert(String, Options) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as String object.

      Parameters:
      content - the AsciiDoc source as String.
      options - a Map of options to control processing (default: {}).
      Returns:
      the rendered output String is returned

    • convert

      @Deprecated <T> T convert(String content, OptionsBuilder options, Class<T> expectedResult)
      Deprecated.
      Use convert(String, Options, Class) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as String object.

      Parameters:
      content - the AsciiDoc source as String.
      options - a Map of options to control processing (default: {}).
      expectedResult - the expected return type. Usually String for HTML based formats. In this case convert(String, OptionsBuilder) is the same.
      Returns:
      the rendered output String is returned

    • convert

      @Deprecated void convert(Reader contentReader, Writer rendererWriter, Map<String,Object> options) throws IOException
      Deprecated.
      Use convert(Reader, Writer, Options) instead.
      Parse the document read from reader sending the converted result to writer.
      Parameters:
      contentReader - where asciidoc content is read.
      rendererWriter - where rendered content is written. Writer is flushed, but not closed.
      options - a Map of options to control processing (default: {}).
      Throws:
      IOException - if an error occurs while writing rendered content, this exception is thrown.

    • convert

      void convert(Reader contentReader, Writer rendererWriter, Options options) throws IOException
      Parse the document read from reader sending the converted result to writer.
      Parameters:
      contentReader - where asciidoc content is read.
      rendererWriter - where rendered content is written. Writer is flushed, but not closed.
      options - options to control processing (default: empty).
      Throws:
      IOException - if an error occurs while writing rendered content, this exception is thrown.

    • convert

      @Deprecated void convert(Reader contentReader, Writer rendererWriter, OptionsBuilder options) throws IOException
      Deprecated.
      Use convert(Reader, Writer, Options) instead.
      Parse the document read from reader sending the converted result to writer.
      Parameters:
      contentReader - where asciidoc content is read.
      rendererWriter - where rendered content is written. Writer is flushed, but not closed.
      options - a Map of options to control processing (default: {}).
      Throws:
      IOException - if an error occurs while writing rendered content, this exception is thrown.

    • convertFile

      @Deprecated String convertFile(File file, Map<String,Object> options)
      Deprecated.
      Use convertFile(File, Options) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as File.

      If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

      Parameters:
      file - an input Asciidoctor file.
      options - a Map of options to control processing (default: {}).
      Returns:
      returns nothing if the rendered output String is written to a file.

    • convertFile

      @Deprecated <T> T convertFile(File file, Map<String,Object> options, Class<T> expectedResult)
      Deprecated.
      User convertFile(File, Options, Class) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as File.

      If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

      Parameters:
      file - an input Asciidoctor file.
      options - a Map of options to control processing (default: {}).
      expectedResult - the expected return type. Usually String for HTML based formats. In this case convertFile(File, Map) is the same.
      Returns:
      returns nothing if the rendered output is written to a file.

    • convertFile

      String convertFile(File file, Options options)
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as File.

      If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

      Parameters:
      file - an input Asciidoctor file.
      options - options to control processing (default: empty).
      Returns:
      returns nothing if the rendered output String is written to a file.

    • convertFile

      <T> T convertFile(File file, Options options, Class<T> expectedResult)
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as File.

      If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

      Parameters:
      file - an input Asciidoctor file.
      options - options to control processing (default: empty).
      expectedResult - the expected return type. Usually String for HTML based formats. In this case convertFile(File, Map) is the same.
      Returns:
      returns nothing if the rendered output is written to a file.

    • convertFile

      @Deprecated String convertFile(File file, OptionsBuilder options)
      Deprecated.
      Use convertFile(File, Options) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as File.

      If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

      Parameters:
      file - an input Asciidoctor file.
      options - a Map of options to control processing (default: {}).
      Returns:
      returns nothing if the rendered output String is written to a file.

    • convertFile

      @Deprecated <T> T convertFile(File file, OptionsBuilder options, Class<T> expectedResult)
      Deprecated.
      User convertFile(File, Options, Class) instead.
      Parse the AsciiDoc source input into an Document Document and convert it to the specified backend format.

      Accepts input as File.

      If the :in_place option is true, and the input is a File, the output is written to a file adjacent to the input file, having an extension that corresponds to the backend format. Otherwise, if the :to_file option is specified, the file is written to that file. If :to_file is not an absolute path, it is resolved relative to :to_dir, if given, otherwise the Document#base_dir. If the target directory does not exist, it will not be created unless the :mkdirs option is set to true. If the file cannot be written because the target directory does not exist, or because it falls outside of the Document#base_dir in safe mode, an IOError is raised.

      Parameters:
      file - an input Asciidoctor file.
      options - a Map of options to control processing (default: {}).
      expectedResult - the expected return type. Usually String for HTML based formats. In this case convertFile(File, Map) is the same.
      Returns:
      returns nothing if the rendered output is written to a file.

    • convertDirectory

      @Deprecated String[] convertDirectory(Iterable<File> directoryWalker, Map<String,Object> options)
      Deprecated.
      Use convertDirectory(Iterable, Options) instead.
      Convert all AsciiDoc files found in directoryWalker. See AsciiDocDirectoryWalker for reference strategy.
      Parameters:
      directoryWalker - strategy used to retrieve all files to be rendered.
      options - a Map of options to control processing (default: {}).
      Returns:
      returns an array of 0 positions if the rendered output is written to a file.

    • convertDirectory

      String[] convertDirectory(Iterable<File> directoryWalker, Options options)
      Convert all AsciiDoc files found in directoryWalker. See AsciiDocDirectoryWalker for reference strategy.
      Parameters:
      directoryWalker - strategy used to retrieve all files to be rendered.
      options - options to control processing (default: empty).
      Returns:
      returns an array of 0 positions if the rendered output is written to a file.

    • convertDirectory

      @Deprecated String[] convertDirectory(Iterable<File> directoryWalker, OptionsBuilder options)
      Deprecated.
      Use convertDirectory(Iterable, Options) instead.
      Convert all AsciiDoc files found in directoryWalker. See AsciiDocDirectoryWalker for reference strategy.
      Parameters:
      directoryWalker - strategy used to retrieve all files to be rendered.
      options - a Map of options to control processing (default: {}).
      Returns:
      returns an array of 0 positions if the rendered output is written to a file.

    • convertFiles

      @Deprecated String[] convertFiles(Collection<File> files, Map<String,Object> options)
      Deprecated.
      Use convertFiles(Collection, Options) instead.
      Convert all files from a collection.
      Parameters:
      files - to be converted.
      options - a Map of options to control processing (default: {}).
      Returns:
      returns an array of 0 positions if the rendered output is written to a file.

    • convertFiles

      String[] convertFiles(Collection<File> asciidoctorFiles, Options options)
      Convert all files from a collection.
      Parameters:
      asciidoctorFiles - to be converted.
      options - options to control processing (default: empty).
      Returns:
      returns an array of 0 positions if the rendered output is written to a file.

    • convertFiles

      @Deprecated String[] convertFiles(Collection<File> files, OptionsBuilder options)
      Deprecated.
      Use convertFiles(Collection, Options) instead.
      Convert all files from a collection.
      Parameters:
      files - to be converted.
      options - a Map of options to control processing (default: {}).
      Returns:
      returns an array of 0 positions if the rendered output is written to a file.

    • requireLibrary

      void requireLibrary(String... requiredLibraries)
      Loads the given Ruby gem(s) by name.
      Parameters:
      requiredLibraries -

    • requireLibraries

      void requireLibraries(Collection<String> requiredLibraries)
      Loads the given Ruby gem in requiredLibraries by name.
      Parameters:
      requiredLibraries -

    • readDocumentHeader

      @Deprecated DocumentHeader readDocumentHeader(File file)
      Deprecated.
      Use loadFile(File, Map) instead.
      Reads only header parameters instead of all document.
      Parameters:
      file - to read the attributes.
      Returns:
      header.

    • readDocumentHeader

      @Deprecated DocumentHeader readDocumentHeader(String content)
      Deprecated.
      Use load(String, Map) instead.
      Reads only header parameters instead of all document.
      Parameters:
      content - where converted content is written. Writer is flushed, but not closed.
      Returns:
      header.

    • readDocumentHeader

      @Deprecated DocumentHeader readDocumentHeader(Reader contentReader)
      Deprecated.
      Use loadFile(File, Map) instead.
      Reads only header parameters instead of all document.
      Parameters:
      contentReader - where asciidoc content is read.
      Returns:
      header.

    • javaExtensionRegistry

      JavaExtensionRegistry javaExtensionRegistry()
      Creates an extension registry ready to be used for registering Java extensions.
      Returns:
      Extension Registry object.

    • rubyExtensionRegistry

      RubyExtensionRegistry rubyExtensionRegistry()
      Creates an Ruby extension registry ready to be used for registering Ruby extension.
      Returns:
      Extension Registry object.

    • javaConverterRegistry

      JavaConverterRegistry javaConverterRegistry()
      Creates a registry for registering Java converters.
      Returns:
      Converter Registry object.

    • syntaxHighlighterRegistry

      SyntaxHighlighterRegistry syntaxHighlighterRegistry()
      Creates a registry for registering Java syntax highlighter.

      This API is experimental and might change in an incompatible way in a minor version update!

      Returns:
      Converter Registry object.

    • createGroup

      ExtensionGroup createGroup()
      Creates an ExtensionGroup that can be used to register and unregister multiples extensions all at once.
      Returns:
      Extension Group instance.

    • createGroup

      ExtensionGroup createGroup(String groupName)
      Creates an ExtensionGroup that can be used to register and unregister multiples extensions all at once.
      Parameters:
      groupName - to assign to the ExtensionGroup.
      Returns:
      Extension Group instance.

    • unregisterAllExtensions

      void unregisterAllExtensions()
      Unregister all registered extensions.

    • shutdown

      void shutdown()
      This method frees all resources consumed by AsciidoctorJ module. Keep in mind that if this method is called, instance becomes unusable and you should create another instance.

    • asciidoctorVersion

      String asciidoctorVersion()
      Method that gets the asciidoctor version which is being used..
      Returns:
      Version number.

    • load

      @Deprecated Document load(String content, Map<String,Object> options)
      Deprecated.
      Use load(String, Options) instead.
      Loads AsciiDoc content and returns the Document object.
      Parameters:
      content - to be parsed.
      options - a Map of options to control processing (default: {}).
      Returns:
      Document of given content.

    • load

      Document load(String content, Options options)
      Loads AsciiDoc content and returns the Document object.
      Parameters:
      content - to be parsed.
      options - options to control processing (default: empty).
      Returns:
      Document of given content.

    • loadFile

      @Deprecated Document loadFile(File file, Map<String,Object> options)
      Deprecated.
      Use loadFile(File, Options) instead.
      Loads AsciiDoc content from file and returns the Document object.
      Parameters:
      file - to be parsed.
      options - a Map of options to control processing (default: {}).
      Returns:
      Document of given content.

    • loadFile

      Document loadFile(File file, Options options)
      Loads AsciiDoc content from file and returns the Document object.
      Parameters:
      file - to be parsed.
      options - options to control processing (default: empty).
      Returns:
      Document of given content.

    • registerLogHandler

      void registerLogHandler(LogHandler logHandler)
      Register a LogHandler to capture Asciidoctor message records.
      Parameters:
      logHandler - handler instance.

    • unregisterLogHandler

      void unregisterLogHandler(LogHandler logHandler)
      Unregister a LogHandler.
      Parameters:
      logHandler - handler instance.

    • unwrap

      default <T> T unwrap(Class<T> clazz)

    • close

      default void close()
      Specified by:
      close in interface AutoCloseable