com.ivata.mask.web.format
Class CharacterEntityFormat

java.lang.Object
  com.ivata.mask.web.format.CharacterEntityFormat

All Implemented Interfaces:

HTMLFormat

public class CharacterEntityFormat

extends java.lang.Object

implements HTMLFormat

Convert characters to their HTML character entity equivalents.

Since:

ivata masks 0.4 (2002-06-19)

Version:

$Revision: 1.3 $

Author:

Colin MacLeod colin.macleod@ivata.com

Constructor Summary

CharacterEntityFormat()
Default constructor.

Method Summary

java.lang.String	format(java.lang.String hTMLText) Convert the character entities in the text provided.
boolean	isReverse() Gets whether or not character entity conversion goes in the opposite direction.
void	setReverse(boolean newReverse) Set whether or not character entity conversion goes in the opposite direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterEntityFormat

public CharacterEntityFormat()

Default constructor.

Method Detail

format

public final java.lang.String format(java.lang.String hTMLText)

Convert the character entities in the text provided.

Specified by:

format in interface HTMLFormat

Parameters:

hTMLText - a text to convert all the character entities in

Returns:

formatted text where all of the characters are converted to the appropriate character entities.

isReverse

public final boolean isReverse()

Gets whether or not character entity conversion goes in the opposite direction. If character entities are converted to characters then this method returns true, otherwise false

Returns:

true if character entities are converted to characters, otherwise false/

setReverse

public final void setReverse(boolean newReverse)

Set whether or not character entity conversion goes in the opposite direction.

Parameters:

newReverse - set to true if character entities should be converted to characters, otherwise false.