Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
 package com.helger.jcodemodel.util;
 import; 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.

Kohsuke Kawaguchi (
 public class JavadocEscapeWriter extends FilterWriter
   public JavadocEscapeWriter (@Nonnull final Writer next)
     super (next);
   public void write (final int chthrows IOException
     if (ch == '<')
       .write ("&lt;");
       if (ch == '&')
         .write ("&amp;");
         .write (ch);
   public void write (@Nonnull final char [] buf, @Nonnegative final int off, @Nonnegative final int lenthrows IOException
     for (int i = 0; i < leni++)
       write (buf[off + i]);
   public void write (@Nonnull final char [] bufthrows IOException
     write (buf, 0, buf.length);
   public void write (@Nonnull final String buf, @Nonnegative final int off, @Nonnegative final int lenthrows IOException
     write (buf.toCharArray (), offlen);
  public void write (@Nonnull final String bufthrows IOException
    write (buf.toCharArray (), 0, buf.length ());
New to GrepCode? Check out our FAQ X