1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.codec.binary;
19
20 import java.io.InputStream;
21
22 /**
23 * Provides Base32 encoding and decoding in a streaming fashion (unlimited size). When encoding the default lineLength
24 * is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate
25 * constructor.
26 * <p>
27 * The default behaviour of the Base32InputStream is to DECODE, whereas the default behaviour of the Base32OutputStream
28 * is to ENCODE, but this behaviour can be overridden by using a different constructor.
29 * </p>
30 * <p>
31 * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
32 * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
33 * </p>
34 *
35 * @version $Id: Base32InputStream.java 1586299 2014-04-10 13:50:21Z ggregory $
36 * @see <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
37 * @since 1.5
38 */
39 public class Base32InputStream extends BaseNCodecInputStream {
40
41 /**
42 * Creates a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
43 *
44 * @param in
45 * InputStream to wrap.
46 */
47 public Base32InputStream(final InputStream in) {
48 this(in, false);
49 }
50
51 /**
52 * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
53 * provided InputStream.
54 *
55 * @param in
56 * InputStream to wrap.
57 * @param doEncode
58 * true if we should encode all data read from us, false if we should decode.
59 */
60 public Base32InputStream(final InputStream in, final boolean doEncode) {
61 super(in, new Base32(false), doEncode);
62 }
63
64 /**
65 * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
66 * provided InputStream.
67 *
68 * @param in
69 * InputStream to wrap.
70 * @param doEncode
71 * true if we should encode all data read from us, false if we should decode.
72 * @param lineLength
73 * If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
74 * nearest multiple of 4). If lineLength <= 0, the encoded data is not divided into lines. If doEncode
75 * is false, lineLength is ignored.
76 * @param lineSeparator
77 * If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
78 * If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
79 */
80 public Base32InputStream(final InputStream in, final boolean doEncode,
81 final int lineLength, final byte[] lineSeparator) {
82 super(in, new Base32(lineLength, lineSeparator), doEncode);
83 }
84
85 }