com.helger.jcodemodel.util

Class JavadocEscapeWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.helger.jcodemodel.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, 愛 (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 (kohsuke.kawaguchi@sun.com)

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
JavadocEscapeWriter(Writer aOut)

Method Summary

Modifier and Type	Method and Description
void	write(char[] aBuf)
void	write(char[] aBuf, int nOfs, int nLen)
void	write(int ch)
void	write(String sStr)
void	write(String sStr, int nOfs, int nLen)

Methods inherited from class java.io.FilterWriter

close, flush

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocEscapeWriter

public JavadocEscapeWriter(@Nonnull
                           Writer aOut)

Method Detail

write

public void write(int ch)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(@Nonnull
                  char[] aBuf,
                  @Nonnegative
                  int nOfs,
                  @Nonnegative
                  int nLen)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(@Nonnull
                  char[] aBuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(@Nonnull
                  String sStr,
                  @Nonnegative
                  int nOfs,
                  @Nonnegative
                  int nLen)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(@Nonnull
                  String sStr)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException