com.sun.codemodel.util
Class JavadocEscapeWriter

java.lang.Object  extended by java.io.Writer      extended by java.io.FilterWriter          extended by com.sun.codemodel.util.JavadocEscapeWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable

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
JavadocEscapeWriter(Writer next)
           
 
Method Summary
 voidwrite(char[] buf)
           
 voidwrite(char[] buf, int off, int len)
           
 voidwrite(int ch)
           
 voidwrite(String buf)
           
 voidwrite(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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocEscapeWriter

public JavadocEscapeWriter(Writer next)
Method Detail

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


Copyright © 2005-2011
Oracle. All Rights Reserved.


NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14