org.asciidoctor.converter

Interface Converter

All Known Implementing Classes:

AbstractConverter

public interface Converter

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convert(AbstractNode node, java.lang.String transform, java.util.Map<java.lang.Object,java.lang.Object> opts) Converts an AbstractNode using the specified transform along with additional options.

Method Detail

convert

java.lang.Object convert(AbstractNode node,
                         java.lang.String transform,
                         java.util.Map<java.lang.Object,java.lang.Object> opts)

Converts an AbstractNode using the specified transform along with additional options. If a transform is not specified, implementations typically derive one from the AbstractNode.getNodeName() property.

Implementations are free to decide how to carry out the conversion. In the case of the built-in converters, the tranform value is used to dispatch to a handler method. The TemplateConverter uses the value of the transform to select a template to render.

Parameters:

node - The concrete instance of AbstractNode to convert

transform - An optional String transform that hints at which transformation should be applied to this node. If a transform is not specified, the transform is typically derived from the value of the node's node_name property. (optional, default: null)

opts - An optional map of options that provide additional hints about how to convert the node. (optional, default: empty map)

Returns:

the converted result