de.ipcon.tools

Class AsciidocTools

java.lang.Object

de.ipcon.tools.AsciidocTools

public final class AsciidocTools
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AsciidocTools()

Method Summary

Modifier and Type	Method and Description
static org.asciidoctor.Asciidoctor	getDOCTOR()
static java.lang.String	nodeToString(org.asciidoctor.ast.StructuralNode node) Returns the relevant information of a StructuralNode of a StructuredDocument.
static <V> org.asciidoctor.ast.Document	parseFileToDocument(V file) Parses an AsciiDoc file into a StructuredDocument.
static <V> org.asciidoctor.ast.Document	parseFileToDocument(V file, org.asciidoctor.Options options) Parses an AsciiDoc file into a StructuredDocument.
static <V> java.lang.String	parseFileToHTML(V srcFile) Parses an AsciiDoc file to HTML output.
static <V> java.lang.String	parseFileToHTML(V srcFile, org.asciidoctor.Options options) Parses an AsciiDoc file to HTML output.
static <V> java.lang.String	parseFileToHTML(V srcFile, org.asciidoctor.Options options, V outFile) Parses an AsciiDoc file to HTML output.
static <V> void	parseFileToPDF(V srcFile, org.asciidoctor.Options options, V outFile) Parses an AsciiDoc file into a PDF File.
static <V> java.lang.String	parseFileWithBackend(V srcFile, org.asciidoctor.Options options) Converts an AsciiDoc file with a backend set in the 'options'.
static <V> java.lang.String	parseFileWithBackend(V srcFile, org.asciidoctor.Options options, V outFile) Converts an AsciiDoc file with a backend set in the 'options'.
static org.asciidoctor.ast.Document	parseStringToDocument(java.lang.String content) Parses an AsciiDoc string into a StructuredDocument.
static org.asciidoctor.ast.Document	parseStringToDocument(java.lang.String content, org.asciidoctor.Options options) Parses an AsciiDoc string into a StructuredDocument.
static java.lang.String	parseStringToHTML(java.lang.String content) Parses an AsciiDoc string to HTML output.
static java.lang.String	parseStringToHTML(java.lang.String content, org.asciidoctor.Options options) Parses an AsciiDoc string to HTML output.
static <V> java.lang.String	parseStringToHTML(java.lang.String content, org.asciidoctor.Options options, V outFile) Parses an AsciiDoc string to HTML output.
static <V> void	parseStringToPDF(java.lang.String content, org.asciidoctor.Options options, V outFile) Parses an AsciiDoc string into a PDF File.
static java.lang.String	parseStringWithBackend(java.lang.String content, org.asciidoctor.Options options) Converts an AsciiDoc string with a backend set in the 'options'.
static <V> java.lang.String	parseStringWithBackend(java.lang.String content, org.asciidoctor.Options options, V outFile) Converts an AsciiDoc string with a backend set in the 'options'.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsciidocTools

public AsciidocTools()

Method Detail

getDOCTOR

public static org.asciidoctor.Asciidoctor getDOCTOR()

parseFileToDocument

public static final <V> org.asciidoctor.ast.Document parseFileToDocument(V file)

Parses an AsciiDoc file into a StructuredDocument.

Parameters:

file - File, Path, or path as String

Returns:

a StructuredDocument built with the given file

parseFileToDocument

public static final <V> org.asciidoctor.ast.Document parseFileToDocument(V file,
                                                                         org.asciidoctor.Options options)

Parses an AsciiDoc file into a StructuredDocument.

Parameters:

file - File, Path, or path as String

options - Options for parsing

Returns:

a StructuredDocument built with the given options and the given file

parseStringToDocument

public static final org.asciidoctor.ast.Document parseStringToDocument(java.lang.String content)

Parses an AsciiDoc string into a StructuredDocument.

Parameters:

content - AsciiDoc content as a string

Returns:

a StructuredDocument built with the given content

parseStringToDocument

public static final org.asciidoctor.ast.Document parseStringToDocument(java.lang.String content,
                                                                       org.asciidoctor.Options options)

Parses an AsciiDoc string into a StructuredDocument.

Parameters:

content - AsciiDoc content as a string

options - Options for parsing

Returns:

a StructuredDocument built with the given options and the given content

nodeToString

public static final java.lang.String nodeToString(org.asciidoctor.ast.StructuralNode node)

Returns the relevant information of a StructuralNode of a StructuredDocument.

Parameters:

node - StructuralNode to convert to string

Returns:

String representation of the StructuralNode

parseFileToHTML

public static final <V> java.lang.String parseFileToHTML(V srcFile)

Parses an AsciiDoc file to HTML output. The converted HTML content is returned.

Parameters:

srcFile - AsciiDoc source file

Returns:

Converted HTML content

parseFileToHTML

public static final <V> java.lang.String parseFileToHTML(V srcFile,
                                                         org.asciidoctor.Options options)

Parses an AsciiDoc file to HTML output. If the options 'in_place' or 'to_file' ('mkdirs') are set, nothing is returned. Else, if the options 'in_place' and 'to_file' are set to 'false' (String), the converted HTML content is returned. Note: if using 'in_place' or a relative path with 'to_file', be sure to set 'base_dir'!

Parameters:

srcFile - AsciiDoc source file

options - Options for parsing

Returns:

Converted HTML content if not writing to file, otherwise null

parseFileToHTML

public static final <V> java.lang.String parseFileToHTML(V srcFile,
                                                         org.asciidoctor.Options options,
                                                         V outFile)

Parses an AsciiDoc file to HTML output. If the options 'in_place' or 'to_file' ('mkdirs') are set, nothing is returned. Else, if the options 'in_place' and 'to_file' are set to 'false' (String), the converted HTML content is returned. Note: if using 'in_place' or a relative path with 'to_file', be sure to set 'base_dir'!

Parameters:

srcFile - AsciiDoc source file

options - Options for parsing

outFile - Output file for HTML content

Returns:

Converted HTML content if not writing to file, otherwise null

parseStringToHTML

public static final java.lang.String parseStringToHTML(java.lang.String content)

Parses an AsciiDoc string to HTML output.

Parameters:

content - AsciiDoc content as a string

Returns:

Converted HTML content

parseStringToHTML

public static final java.lang.String parseStringToHTML(java.lang.String content,
                                                       org.asciidoctor.Options options)

Parses an AsciiDoc string to HTML output.

Parameters:

content - AsciiDoc content as a string

options - Options for parsing

Returns:

Converted HTML content if not writing to file, otherwise null

parseStringToHTML

public static final <V> java.lang.String parseStringToHTML(java.lang.String content,
                                                           org.asciidoctor.Options options,
                                                           V outFile)

Parses an AsciiDoc string to HTML output.

Parameters:

content - AsciiDoc content as a string

options - Options for parsing

outFile - Output file for HTML content

Returns:

Converted HTML content if not writing to file, otherwise null

parseFileToPDF

public static final <V> void parseFileToPDF(V srcFile,
                                            org.asciidoctor.Options options,
                                            V outFile)

Parses an AsciiDoc file into a PDF File. If the options 'in_place' or 'to_file' ('mkdirs') are set, nothing is returned. Else, if the options 'in_place' and 'to_file' are set to 'false' (String), the converted PDF content is returned. Note: if using 'in_place' or a relative path with 'to_file', be sure to set 'base_dir'!

Parameters:

srcFile - AsciiDoc source file

options - Options for parsing

outFile - Output file for PDF content

parseStringToPDF

public static final <V> void parseStringToPDF(java.lang.String content,
                                              org.asciidoctor.Options options,
                                              V outFile)

Parses an AsciiDoc string into a PDF File.

Parameters:

content - AsciiDoc content as a string

options - Options for parsing

outFile - Output file for PDF content

parseFileWithBackend

public static final <V> java.lang.String parseFileWithBackend(V srcFile,
                                                              org.asciidoctor.Options options)

Converts an AsciiDoc file with a backend set in the 'options'. If the backend is 'pdf', the return value will be null. If the options 'in_place' or 'to_file' ('mkdirs') are set, nothing is returned. Else, if the options 'in_place' and 'to_file' are set to 'false' (String), the converted PDF content is returned. Note: if using 'in_place' or a relative path with 'to_file', be sure to set 'base_dir'!

Parameters:

srcFile - AsciiDoc source file

options - Options for parsing

Returns:

Converted content if not writing to file, otherwise null

parseFileWithBackend

public static final <V> java.lang.String parseFileWithBackend(V srcFile,
                                                              org.asciidoctor.Options options,
                                                              V outFile)

Converts an AsciiDoc file with a backend set in the 'options'. If the backend is 'pdf', the return value will be null. If the options 'in_place' or 'to_file' ('mkdirs') are set, nothing is returned. Else, if the options 'in_place' and 'to_file' are set to 'false' (String), the converted PDF content is returned. Note: if using 'in_place' or a relative path with 'to_file', be sure to set 'base_dir'!

Parameters:

srcFile - AsciiDoc source file

options - Options for parsing

outFile - Output file for converted content

Returns:

Converted content if not writing to file, otherwise null

parseStringWithBackend

public static final java.lang.String parseStringWithBackend(java.lang.String content,
                                                            org.asciidoctor.Options options)

Converts an AsciiDoc string with a backend set in the 'options'.

Parameters:

content - AsciiDoc content as a string

options - Options for parsing

Returns:

Converted content if not writing to file, otherwise null

parseStringWithBackend

public static final <V> java.lang.String parseStringWithBackend(java.lang.String content,
                                                                org.asciidoctor.Options options,
                                                                V outFile)

Converts an AsciiDoc string with a backend set in the 'options'.

Parameters:

content - AsciiDoc content as a string

options - Options for parsing

outFile - Output file for converted content

Returns:

Converted content if not writing to file, otherwise null