Coverage Report

Coverage Report - org.apache.commons.codec.binary.Base64InputStream

Classes in this File

Line Coverage

Branch Coverage

Complexity

Base64InputStream

100%

6/6

N/A

 /*
  * 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.
  */
 
 package org.apache.commons.codec.binary;
 
 import java.io.InputStream;
 
 /**
  * Provides Base64 encoding and decoding in a streaming fashion (unlimited size). When encoding the default lineLength
  * is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate
  * constructor.
  * <p>
  * The default behaviour of the Base64InputStream is to DECODE, whereas the default behaviour of the Base64OutputStream
  * is to ENCODE, but this behaviour can be overridden by using a different constructor.
  * </p>
  * <p>
  * This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> from RFC 2045 <cite>Multipurpose
  * Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies</cite> by Freed and Borenstein.
  * </p>
  * <p>
  * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
  * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
  * </p>
  *
  * @version $Id$
  * @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
  * @since 1.4
  */
 public class Base64InputStream extends BaseNCodecInputStream {
 
     /**
      * Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
      *
      * @param in
      *            InputStream to wrap.
      */
     public Base64InputStream(final InputStream in) {
         this(in, false);
     }
 
     /**
      * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
      * provided InputStream.
      *
      * @param in
      *            InputStream to wrap.
      * @param doEncode
      *            true if we should encode all data read from us, false if we should decode.
      */
     public Base64InputStream(final InputStream in, final boolean doEncode) {
         super(in, new Base64(false), doEncode);
     }
 
     /**
      * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
      * provided InputStream.
      *
      * @param in
      *            InputStream to wrap.
      * @param doEncode
      *            true if we should encode all data read from us, false if we should decode.
      * @param lineLength
      *            If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
      *            nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
      *            false, lineLength is ignored.
      * @param lineSeparator
      *            If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
      *            If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
      */
     public Base64InputStream(final InputStream in, final boolean doEncode,
                              final int lineLength, final byte[] lineSeparator) {
         super(in, new Base64(lineLength, lineSeparator), doEncode);
     }
 }

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 Base64 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 Base64InputStream is to DECODE, whereas the default behaviour of the Base64OutputStream
28		* is to ENCODE, but this behaviour can be overridden by using a different constructor.
29		* </p>
30		* <p>
31		* This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> from RFC 2045 <cite>Multipurpose
32		* Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies</cite> by Freed and Borenstein.
33		* </p>
34		* <p>
35		* Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
36		* character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
37		* </p>
38		*
39		* @version $Id$
40		* @see <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
41		* @since 1.4
42		*/
43		public class Base64InputStream extends BaseNCodecInputStream {
44
45		/**
46		* Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
47		*
48		* @param in
49		* InputStream to wrap.
50		*/
51		public Base64InputStream(final InputStream in) {
52	324	this(in, false);
53	324	}
54
55		/**
56		* Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
57		* provided InputStream.
58		*
59		* @param in
60		* InputStream to wrap.
61		* @param doEncode
62		* true if we should encode all data read from us, false if we should decode.
63		*/
64		public Base64InputStream(final InputStream in, final boolean doEncode) {
65	3464	super(in, new Base64(false), doEncode);
66	3464	}
67
68		/**
69		* Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
70		* provided InputStream.
71		*
72		* @param in
73		* InputStream to wrap.
74		* @param doEncode
75		* true if we should encode all data read from us, false if we should decode.
76		* @param lineLength
77		* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
78		* nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
79		* false, lineLength is ignored.
80		* @param lineSeparator
81		* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
82		* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
83		*/
84		public Base64InputStream(final InputStream in, final boolean doEncode,
85		final int lineLength, final byte[] lineSeparator) {
86	3459	super(in, new Base64(lineLength, lineSeparator), doEncode);
87	3459	}
88		}