com.hcl.domino.html

Interface RichTextHTMLConverter.Builder

Enclosing interface:

RichTextHTMLConverter

public static interface RichTextHTMLConverter.Builder

Since:

1.0.3

Method Summary

Modifier and Type	Method and Description
HtmlConversionResult	convert() Converts the document or item with the configured options.
RichTextHTMLConverter.Builder	option(HtmlConvertOption option, String value) Sets an HTML conversion option based on the HtmlConvertOption enumeration.
RichTextHTMLConverter.Builder	option(String option, String value) Sets an HTML conversion option based on a string name.
RichTextHTMLConverter.Builder	options(Collection<HtmlConvertOption> options, String value) Sets multiple HTML conversion option based on the HtmlConvertOption enumeration.
RichTextHTMLConverter.Builder	options(Collection<String> options) Sets multiple HTML conversion options.
RichTextHTMLConverter.Builder	userAgent(String userAgent) Sets the user agent string to be used during HTML conversion.

Method Detail

option

RichTextHTMLConverter.Builder option(HtmlConvertOption option,
                                     String value)

Sets an HTML conversion option based on the HtmlConvertOption enumeration.

Parameters:

option - the option to set

value - the option's value. This is usually "1"

Returns:

this builder

Throws:

NullPointerException - if option is null

option

RichTextHTMLConverter.Builder option(String option,
                                     String value)

Sets an HTML conversion option based on a string name.

Parameters:

option - the option to set

value - the option's value. This is usually "1"

Returns:

this builder

Throws:

NullPointerException - if option is null

IllegalArgumentException - if option is empty

options

RichTextHTMLConverter.Builder options(Collection<HtmlConvertOption> options,
                                      String value)

Sets multiple HTML conversion option based on the HtmlConvertOption enumeration.

Parameters:

options - the options to set

value - the options' value. This is usually "1"

Returns:

this builder

Throws:

NullPointerException - if option is null

options

RichTextHTMLConverter.Builder options(Collection<String> options)

Sets multiple HTML conversion options.

Note: these options must be "key=value" pairs. To use HtmlConvertOption values, use the HtmlConvertOption.toOption(String) method.

Parameters:

options - the key/value option pairs to set.

Returns:

this builder

userAgent

RichTextHTMLConverter.Builder userAgent(String userAgent)

Sets the user agent string to be used during HTML conversion.

Parameters:

userAgent - the user agent string to set

Returns:

this builder

convert

HtmlConversionResult convert()

Converts the document or item with the configured options.

Returns:

the conversion result