com.tutego.jrtf

Class RtfTemplate

java.lang.Object

com.tutego.jrtf.RtfTemplate

public class RtfTemplate
extends Object

This class is able to make variable substitutions in an existing RTF file.

 Rtf.template( new FileInputStream("template.rtf) )
    .inject( "ADDRESSLINE1", "tutego" )
    .inject( "ADDRESSLINE2", bold("Sonsbeck") )
    .out( FileOutputStream("out.rtf") );
 

Just use ASCII-keys.

Method Summary

Methods

Modifier and Type	Method and Description
RtfTemplate	inject(Map<String,Object> map) Adds key/values pairs for a variable substitution.
RtfTemplate	inject(String key, Object value) Adds a key/value pair for substitution.
String	out() Performs the variable transformation and returns the transformed RTF document.
void	out(OutputStream out) Performs the variable transformation and writes the RTF document and send the output to an Appendable.

Methods inherited from class java.lang.Object

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

Method Detail

inject

public RtfTemplate inject(Map<String,Object> map)

Adds key/values pairs for a variable substitution. Keep the keys in pure ASCII.

Parameters:

map - Map with key/value pairs.

Returns:

this object.

inject

public RtfTemplate inject(String key,
                 Object value)

Adds a key/value pair for substitution. Keep the key in pure ASCII. The value will be converted to String by String.valueOf(Object).

Parameters:

key - Key.

value - Value.

Returns:

this object.

out

public String out()

Performs the variable transformation and returns the transformed RTF document.

Returns:

RTF document after variable substitution.

out

public void out(OutputStream out)

Performs the variable transformation and writes the RTF document and send the output to an Appendable. This method closes the Appendable after writing if its of type Closeable.

Parameters:

out - Destination of this RTF output.