Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Base32OutputStream |
|
| 1.0;1 |
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.OutputStream; | |
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 Base32OutputStream is to ENCODE, whereas the default behaviour of the Base32InputStream | |
28 | * is to DECODE. 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$ | |
36 | * @see <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a> | |
37 | * @since 1.5 | |
38 | */ | |
39 | public class Base32OutputStream extends BaseNCodecOutputStream { | |
40 | ||
41 | /** | |
42 | * Creates a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream. | |
43 | * | |
44 | * @param out | |
45 | * OutputStream to wrap. | |
46 | */ | |
47 | public Base32OutputStream(OutputStream out) { | |
48 | 3 | this(out, true); |
49 | 3 | } |
50 | ||
51 | /** | |
52 | * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the | |
53 | * original provided OutputStream. | |
54 | * | |
55 | * @param out | |
56 | * OutputStream to wrap. | |
57 | * @param doEncode | |
58 | * true if we should encode all data written to us, false if we should decode. | |
59 | */ | |
60 | public Base32OutputStream(OutputStream out, boolean doEncode) { | |
61 | 3545 | super(out, new Base32(false), doEncode); |
62 | 3545 | } |
63 | ||
64 | /** | |
65 | * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the | |
66 | * original provided OutputStream. | |
67 | * | |
68 | * @param out | |
69 | * OutputStream to wrap. | |
70 | * @param doEncode | |
71 | * true if we should encode all data written to 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 is | |
75 | * 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 Base32OutputStream(OutputStream out, boolean doEncode, int lineLength, byte[] lineSeparator) { | |
81 | 3388 | super(out, new Base32(lineLength, lineSeparator), doEncode); |
82 | 3388 | } |
83 | ||
84 | } |