Package com.sun.codemodel.util

Class JavadocEscapeWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.sun.codemodel.util.JavadocEscapeWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class JavadocEscapeWriter
extends FilterWriter

Writer that escapes characters that are unsafe as Javadoc comments. Such characters include '<' and '&'.

Note that this class doesn't escape other Unicode characters that are typically unsafe. For example, &#x611B; (A kanji that means "love") can be considered as unsafe because javac with English Windows cannot accept this character in the source code.

If the application needs to escape such characters as well, then they are on their own.

Author:

Kohsuke Kawaguchi ([email protected])

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
JavadocEscapeWriter(Writer next)

Method Summary

Modifier and Type	Method	Description
void	write(char[] buf)
void	write(char[] buf, int off, int len)
void	write(int ch)
void	write(String buf)
void	write(String buf, int off, int len)

Methods inherited from class java.io.FilterWriter

close, flush

Methods inherited from class java.io.Writer

append, append, append, nullWriter

Methods inherited from class java.lang.Object

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

Constructor Details

JavadocEscapeWriter

public JavadocEscapeWriter(Writer next)

Method Details

write

public void write(int ch)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(char[] buf,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(char[] buf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String buf,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(String buf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException