blob: 6a3c8808693376a31aaccd245ba3c48239222e41 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Extensions to standard Java I/O ({@link java.io.Reader}, {@link java.io.Writer},
* {@link java.lang.Appendable}).
* Many classes defined in this package are filters applying on-the-fly formatting while writing
* text to the output device. For example {@link org.apache.sis.io.LineAppender} can wrap lines
* to some maximal line length (e.g. 80 characters), and {@link org.apache.sis.io.TableAppender}
* replaces all occurrence of {@code '\t'} by the amount of spaces needed for producing a tabular
* output.
*
* <div class="note"><b>Note:</b>
* One of the formatter classes defined in this package is a {@link java.text.Format java.text.Format} subclass.
* While traditionally though as part of {@code text} packages, that {@code Format} is defined in this I/O package
* because it can format to an {@link java.lang.Appendable} and for consistency with the {@link org.apache.sis.io.wkt}
* package.</div>
*
* <div class="section">Unicode characters</div>
* Some formatters in this package make extensive use of Unicode characters. This may produce
* unexpected results in a Windows console, unless the underlying output stream uses the correct
* encoding (e.g. {@code new OutputStreamWriter(System.out, "Cp437")}). To display the appropriate
* code page for a Windows console, type {@code chcp} on the command line.
*
* <div class="section">Supplementary Unicode characters</div>
* This package can handle the {@linkplain java.lang.Character#isSupplementaryCodePoint(int)
* Unicode supplementary characters}.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @version 0.3
* @since 0.3
* @module
*/
package org.apache.sis.io;