org.apache.myfaces.buildtools.maven2.plugin.xrts

Interface RTSWriter

All Known Implementing Classes:

ListRTSWriter

public interface RTSWriter

The RTSWriter interface defines methods for writing the header, body, and footer of various output implementations.

The methods startBundle and endBundle write the header and footer portions to the output. The methods for writing the body are writeString, writeStringArray, and writeMap. These methods are supplied with data parsed by the XML-based RTS file XRTSParser or the RTSProperties parser.

Version:

$Name: $ ($Revision: 1.7 $) $Date: 2001/04/09 23:22:22 $

See Also:

ListRTSWriter

Method Summary

Methods

Modifier and Type	Method and Description
void	endBundle(Map parms, Map meta) Writes the file or other output footer(s).
void	startBundle(Map parms, Map meta) Writes the
void	writeString(Map parms, Map meta, String key, String value) Writes a String to the implementation output.

Method Detail

startBundle

void startBundle(Map parms,
               Map meta)
                 throws Throwable

Writes the

Parameters:

parms - a Map of command line parameters.

meta - a Map of parsed non-resource data (e.g., package).

Throws:

Throwable

writeString

void writeString(Map parms,
               Map meta,
               String key,
               String value)
                 throws Throwable

Writes a String to the implementation output.

This is the typical case use. A single String key associated with a single String value forming a key/value pair (kvp). Note that the other two body methods, writeStringArray and writeMap both support a single String key associated with multiple values.

A key/value pair may have associated attributes in the RTS file. In this method, these are received from the XML parser as a Map.

Parameters:

parms - a Map of command line parameters

meta - a Map of parsed non-resource data (e.g., package).

key - a String key.

value - a String value.

Throws:

Throwable

endBundle

void endBundle(Map parms,
             Map meta)
               throws Throwable

Writes the file or other output footer(s).

Parameters:

parms - a Map of command line parameters.

meta - a Map of parsed non-resource data (e.g., package).

Throws:

Throwable