From b21473d2a811b4eae6572cc278e7a848845162d5 Mon Sep 17 00:00:00 2001 From: campbell-burnet = campbell-burnet Date: Sat, 24 Sep 2022 16:56:29 +0000 Subject: [PATCH] add missing class-scope javadoc. git-svn-id: http://svn.code.sf.net/p/hsqldb/svn/base/trunk@6613 7c7dc5f5-a22d-0410-a3af-b41755a11667 --- src/org/hsqldb/lib/AsciiOutputStream.java | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/org/hsqldb/lib/AsciiOutputStream.java b/src/org/hsqldb/lib/AsciiOutputStream.java index dac5e7054..83e43628f 100644 --- a/src/org/hsqldb/lib/AsciiOutputStream.java +++ b/src/org/hsqldb/lib/AsciiOutputStream.java @@ -27,8 +27,6 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ - - package org.hsqldb.lib; import java.io.IOException; @@ -37,6 +35,11 @@ import java.util.Objects; /** + * An OutputStream that writes 7-bit US-ASCII values to a Writer, in compliance + * with the Java US_ASCII Charset decoder. + *

+ * In particular, values greater than {@link #ASCII_MAX) are written as + * {@link #NON_ASCII_REPLACEMENT}. * * @author Campbell Burnet (campbell-burnet@users dot sourceforge.net) */ @@ -53,17 +56,18 @@ public class AsciiOutputStream extends OutputStream { /** * is 2^7 - 1 (127) */ - public static final int ASCII_MAX = 127; + public static final int ASCII_MAX = 127; /** - * is 2^7 (128) + * is 2^7 (128) */ public static final int NON_ASCII_MIN = 128; /** * is '\uFFFD' (65533), the Unicode replacement character. - * + * * @see https://www.fileformat.info/info/unicode/char/fffd/index.htm */ - private static final int NON_ASCII_REPLACEMENT = '\uFFFD'; + public static final int NON_ASCII_REPLACEMENT = '\uFFFD'; + private final Writer writer; public AsciiOutputStream(Writer writer) {