    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017
    018package org.apache.commons.codec.binary;
    019
    020import java.io.InputStream;
    021
    022/**
    023 * Provides Base32 encoding and decoding in a streaming fashion (unlimited size). When encoding the default lineLength
    024 * is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate
    025 * constructor.
    026 * <p>
    027 * The default behaviour of the Base32InputStream is to DECODE, whereas the default behaviour of the Base32OutputStream
    028 * is to ENCODE, but this behaviour can be overridden by using a different constructor.
    029 * </p>
    030 * <p>
    031 * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
    032 * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
    033 * </p>
    034 *
    035 * @see <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
    036 * @since 1.5
    037 */
    038public class Base32InputStream extends BaseNCodecInputStream {
    039
    040    /**
    041     * Creates a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
    042     *
    043     * @param in
    044     *            InputStream to wrap.
    045     */
    046    public Base32InputStream(final InputStream in) {
    047        this(in, false);
    048    }
    049
    050    /**
    051     * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
    052     * provided InputStream.
    053     *
    054     * @param in
    055     *            InputStream to wrap.
    056     * @param doEncode
    057     *            true if we should encode all data read from us, false if we should decode.
    058     */
    059    public Base32InputStream(final InputStream in, final boolean doEncode) {
    060        super(in, new Base32(false), doEncode);
    061    }
    062
    063    /**
    064     * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
    065     * provided InputStream.
    066     *
    067     * @param in
    068     *            InputStream to wrap.
    069     * @param doEncode
    070     *            true if we should encode all data read from us, false if we should decode.
    071     * @param lineLength
    072     *            If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
    073     *            nearest multiple of 4). If lineLength &lt;= 0, the encoded data is not divided into lines. If doEncode
    074     *            is false, lineLength is ignored.
    075     * @param lineSeparator
    076     *            If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
    077     *            If lineLength &lt;= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
    078     */
    079    public Base32InputStream(final InputStream in, final boolean doEncode,
    080                             final int lineLength, final byte[] lineSeparator) {
    081        super(in, new Base32(lineLength, lineSeparator), doEncode);
    082    }
    083
    084}