org.fulib.tools.pipe

Class HtmlPipe

java.lang.Object

org.fulib.tools.pipe.HtmlPipe

All Implemented Interfaces:

Pipe

public class HtmlPipe
extends java.lang.Object
implements Pipe

A pipe that escapes any HTML4 special characters using HTML entities. Useful in plain Javadoc contexts.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
HtmlPipe()

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.lang.String content, java.lang.String arg) Transforms the input text of the code fragment to the output format specified by this pipe.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

HtmlPipe

public HtmlPipe()

Method Detail

apply

public java.lang.String apply(java.lang.String content,
                              java.lang.String arg)

Description copied from interface: Pipe

Transforms the input text of the code fragment to the output format specified by this pipe.

Specified by:

apply in interface Pipe

Parameters:

content - the input text

arg - the pipe argument of the form <pipeName> or <pipeName>:<args>

Returns:

the transformed text