JAXB OSGI 4.0.9 · com.sun.codemodel.util.JavadocEscapeWriter

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.

Constructor Summary

Access	Constructor and Description
public	JavadocEscapeWriter(Writer next)

Method Summary

Modifier and Type	Method and Description
public void	write(int ch) Overrides java.io.FilterWriter.write. Writes a single character.
public void	write(char[] buf, int off, int len) Overrides java.io.FilterWriter.write. Writes a portion of an array of characters.
public void	write(char[] buf) Overrides java.io.Writer.write. Writes an array of characters.
public void	write(String buf, int off, int len) Overrides java.io.FilterWriter.write. Writes a portion of a string.
public void	write(String buf) Overrides java.io.Writer.write. Writes a string.

Inherited from java.io.FilterWriter:: close flush

Constructor Detail

JavadocEscapeWriter	back to summary
public JavadocEscapeWriter(Writer next)

Method Detail

write	back to summary
public void write(int ch) throws IOException Overrides java.io.FilterWriter.write. Doc from java.io.FilterWriter.write. Writes a single character. Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(int ch) throws IOException

Overrides java.io.FilterWriter.write.

Doc from java.io.FilterWriter.write.

Writes a single character.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(char[] buf, int off, int len) throws IOException Overrides java.io.FilterWriter.write. Doc from java.io.FilterWriter.write. Writes a portion of an array of characters. Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

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

Overrides java.io.FilterWriter.write.

Doc from java.io.FilterWriter.write.

Writes a portion of an array of characters.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(char[] buf) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes an array of characters. Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(char[] buf) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes an array of characters.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String buf, int off, int len) throws IOException Overrides java.io.FilterWriter.write. Doc from java.io.FilterWriter.write. Writes a portion of a string. Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

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

Overrides java.io.FilterWriter.write.

Doc from java.io.FilterWriter.write.

Writes a portion of a string.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String buf) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a string. Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(String buf) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a string.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

public Class JavadocEscapeWriter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail