com.sun.codemodel.util.JavadocEscapeWriter Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.codemodel.util;
import java.io.FilterWriter;
import java.io.IOException;
import java.io.Writer;
/**
* {@link 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, {@literal 愛} (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])
*/
public class JavadocEscapeWriter extends FilterWriter {
public JavadocEscapeWriter( Writer next ) {
super(next);
}
@Override
public void write(int ch) throws IOException {
if(ch=='<')
out.write("<");
else
if(ch=='&')
out.write("&");
else
if(ch=='>')
out.write(">");
else
out.write(ch);
}
@Override
public void write(char[] buf, int off, int len) throws IOException {
for( int i=0; i