com.ecyrd.jspwiki

Class TranslatorReader

java.lang.Object

java.io.Reader

com.ecyrd.jspwiki.TranslatorReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

Deprecated.

public class TranslatorReader
extends java.io.Reader

Handles conversion from Wiki format into fully featured HTML. This is where all the magic happens. It is CRITICAL that this class is tested, or all Wikis might die horribly.

The output of the HTML has not yet been validated against the HTML DTD. However, it is very simple.

This class is officially deprecated in 2.3, and will be replaced with a dummy class later on. Please see MarkupParser.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_INLINEPATTERN Deprecated. The default inlining pattern.
static java.lang.String	PROP_ALLOWHTML Deprecated. If set to "true", allows using raw HTML within Wiki text.
static java.lang.String	PROP_CAMELCASELINKS Deprecated. If true, consider CamelCase hyperlinks as well.
static java.lang.String	PROP_INLINEIMAGEPTRN Deprecated. This property defines the inline image pattern.
static java.lang.String	PROP_PLAINURIS Deprecated. If true, all hyperlinks are translated as well, regardless whether they are surrounded by brackets.
static java.lang.String	PROP_RUNPLUGINS Deprecated. If set to "true", enables plugins during parsing
static java.lang.String	PROP_USEOUTLINKIMAGE Deprecated. If true, all outward links (external links) have a small link image appended.
static java.lang.String	PROP_USERELNOFOLLOW Deprecated. If set to "true", all external links are tagged with 'rel="nofollow"'

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
TranslatorReader(WikiContext context, java.io.Reader in) Deprecated. Creates a TranslatorReader using the default HTML renderer.
TranslatorReader(WikiContext context, java.io.Reader in, java.lang.Object renderer) Deprecated. Creates a TranslatorReader.

Method Summary

Modifier and Type	Method and Description
void	addAttachmentLinkHook(StringTransmutator mutator) Deprecated. Adds a hook for processing attachment links.
void	addExternalLinkHook(StringTransmutator mutator) Deprecated. Adds a hook for processing external links.
void	addHeadingListener(HeadingListener listener) Deprecated. Adds a listener to headings.
void	addLinkTransmutator(StringTransmutator mutator) Deprecated. Adds a hook for processing link texts.
void	addLocalLinkHook(StringTransmutator mutator) Deprecated. Adds a hook for processing local links.
static java.lang.String	cleanLink(java.lang.String link) Deprecated. Cleans a Wiki name.
void	close() Deprecated.
void	disableAccessRules() Deprecated. Disables access rules parsing.
void	enableImageInlining(boolean toggle) Deprecated. Use this to turn on or off image inlining.
void	enablePlugins(boolean toggle) Deprecated. Can be used to turn on plugin execution on a translator-reader basis
protected static java.util.Collection	getImagePatterns(WikiEngine engine) Deprecated. Figure out which image suffixes should be inlined.
java.lang.String	makeLink(int type, java.lang.String link, java.lang.String text) Deprecated. Write a HTMLized link depending on its type.
int	read() Deprecated.
int	read(char[] buf, int off, int len) Deprecated.
boolean	ready() Deprecated.
java.io.Reader	setInputReader(java.io.Reader in) Deprecated. Replaces the current input character stream with a new one.
protected void	setRenderer(java.lang.Object renderer) Deprecated. Does not work, don't try to use it.

Methods inherited from class java.io.Reader

mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

PROP_INLINEIMAGEPTRN

public static final java.lang.String PROP_INLINEIMAGEPTRN

Deprecated.

This property defines the inline image pattern. It's current value is jspwiki.translatorReader.inlinePattern

See Also:

Constant Field Values

PROP_CAMELCASELINKS

public static final java.lang.String PROP_CAMELCASELINKS

Deprecated.

If true, consider CamelCase hyperlinks as well.

See Also:

Constant Field Values

PROP_PLAINURIS

public static final java.lang.String PROP_PLAINURIS

Deprecated.

If true, all hyperlinks are translated as well, regardless whether they are surrounded by brackets.

See Also:

Constant Field Values

PROP_USEOUTLINKIMAGE

public static final java.lang.String PROP_USEOUTLINKIMAGE

Deprecated.

If true, all outward links (external links) have a small link image appended.

See Also:

Constant Field Values

PROP_ALLOWHTML

public static final java.lang.String PROP_ALLOWHTML

Deprecated.

If set to "true", allows using raw HTML within Wiki text. Be warned, this is a VERY dangerous option to set - never turn this on in a publicly allowable Wiki, unless you are absolutely certain of what you're doing.

See Also:

Constant Field Values

PROP_USERELNOFOLLOW

public static final java.lang.String PROP_USERELNOFOLLOW

Deprecated.

If set to "true", all external links are tagged with 'rel="nofollow"'

See Also:

Constant Field Values

PROP_RUNPLUGINS

public static final java.lang.String PROP_RUNPLUGINS

Deprecated.

If set to "true", enables plugins during parsing

See Also:

Constant Field Values

DEFAULT_INLINEPATTERN

public static final java.lang.String DEFAULT_INLINEPATTERN

Deprecated.

The default inlining pattern. Currently "*.png"

See Also:

Constant Field Values

Constructor Detail

TranslatorReader

public TranslatorReader(WikiContext context,
                        java.io.Reader in)

Deprecated.

Creates a TranslatorReader using the default HTML renderer.

Parameters:

context - WikiContext

in - The reader from which to read.

TranslatorReader

public TranslatorReader(WikiContext context,
                        java.io.Reader in,
                        java.lang.Object renderer)

Deprecated.

Creates a TranslatorReader.

Parameters:

context - WikiContext

in - Reader

renderer - Unused.

Method Detail

setInputReader

public java.io.Reader setInputReader(java.io.Reader in)

Deprecated.

Replaces the current input character stream with a new one.

Parameters:

in - New source for input. If null, this method does nothing.

Returns:

the old stream

setRenderer

protected void setRenderer(java.lang.Object renderer)

Deprecated.

Does not work, don't try to use it.

Parameters:

renderer - Renderer.

addLinkTransmutator

public void addLinkTransmutator(StringTransmutator mutator)

Deprecated.

Adds a hook for processing link texts. This hook is called when the link text is written into the output stream, and you may use it to modify the text. It does not affect the actual link, only the user-visible text.

Parameters:

mutator - The hook to call. Null is safe.

addLocalLinkHook

public void addLocalLinkHook(StringTransmutator mutator)

Deprecated.

Adds a hook for processing local links. The engine transforms both non-existing and existing page links.

Parameters:

mutator - The hook to call. Null is safe.

addExternalLinkHook

public void addExternalLinkHook(StringTransmutator mutator)

Deprecated.

Adds a hook for processing external links. This includes all http:// ftp://, etc. links, including inlined images.

Parameters:

mutator - The hook to call. Null is safe.

addAttachmentLinkHook

public void addAttachmentLinkHook(StringTransmutator mutator)

Deprecated.

Adds a hook for processing attachment links.

Parameters:

mutator - The hook to call. Null is safe.

addHeadingListener

public void addHeadingListener(HeadingListener listener)

Deprecated.

Adds a listener to headings.

Parameters:

listener - Listener to add.

disableAccessRules

public void disableAccessRules()

Deprecated.

Disables access rules parsing.

enablePlugins

public void enablePlugins(boolean toggle)

Deprecated.

Can be used to turn on plugin execution on a translator-reader basis

Parameters:

toggle - on or off

enableImageInlining

public void enableImageInlining(boolean toggle)

Deprecated.

Use this to turn on or off image inlining.

Parameters:

toggle - If true, images are inlined (as per set in jspwiki.properties) If false, then images won't be inlined; instead, they will be treated as standard hyperlinks.

Since:

2.2.9

getImagePatterns

protected static java.util.Collection getImagePatterns(WikiEngine engine)

Deprecated.

Figure out which image suffixes should be inlined.

Parameters:

engine - WikiEngine

Returns:

Collection of Strings with patterns.

makeLink

public java.lang.String makeLink(int type,
                                 java.lang.String link,
                                 java.lang.String text)

Deprecated.

Write a HTMLized link depending on its type. The link mutator chain is processed.

Parameters:

type - Type of the link.

link - The actual link.

text - The user-visible text for the link.

Returns:

link

cleanLink

public static java.lang.String cleanLink(java.lang.String link)

Deprecated.

Cleans a Wiki name.

[ This is a link ] -> ThisIsALink

Parameters:

link - Link to be cleared. Null is safe, and causes this to return null.

Returns:

A cleaned link.

Since:

2.0

read

public int read()
         throws java.io.IOException

Deprecated.

Overrides:

read in class java.io.Reader

Throws:

java.io.IOException

read

public int read(char[] buf,
                int off,
                int len)
         throws java.io.IOException

Deprecated.

Specified by:

read in class java.io.Reader

Throws:

java.io.IOException

ready

public boolean ready()
              throws java.io.IOException

Deprecated.

Overrides:

ready in class java.io.Reader

Throws:

java.io.IOException

close

public void close()

Deprecated.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Reader