Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.macro
Class Preserved

java.lang.Object
  extended by com.jivesoftware.forum.renderer.macro.Preserved
Direct Known Subclasses:
CodeMacro

public abstract class Preserved
extends java.lang.Object

A specialized macro that allows to preserve certain special characters by creating character entities. The subclassing macro may decide whether to call replace() before or after executing the actual macro substitution. . Jugel

Version:
$Id: Preserved.java 37580 2006-11-24 16:10:51Z bruce $

Constructor Summary
Preserved()
           
 
Method Summary
protected  void addSpecial(char c)
          Encode special character c by replacing with it's hex character entity code.
protected  void addSpecial(java.lang.String c, java.lang.String replacement)
          Add a replacement for the special character c which may be a string
protected  java.lang.String replace(java.lang.String source)
          Actually replace specials in source.
static char toChar(java.lang.String number)
           
static java.lang.String toEntity(int c)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Preserved

public Preserved()
Method Detail

addSpecial

protected void addSpecial(char c)
Encode special character c by replacing with it's hex character entity code.

Parameters:
c - add character as a special character

addSpecial

protected void addSpecial(java.lang.String c,
                          java.lang.String replacement)
Add a replacement for the special character c which may be a string

Parameters:
c - the character to replace
replacement - the new string

replace

protected java.lang.String replace(java.lang.String source)
Actually replace specials in source. This method can be used by subclassing macros.

Parameters:
source - String to encode
Returns:
encoded Encoded string

toEntity

public static java.lang.String toEntity(int c)

toChar

public static char toChar(java.lang.String number)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.