src/main/java/org/apache/commons/codec/binary/Base32InputStream.java - commons-codec - Git at Google

 /*
  * 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
  *
  *      https://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;

 import org.apache.commons.codec.CodecPolicy;
 import org.apache.commons.codec.binary.BaseNCodecInputStream.AbstracBuilder; // NOPMD: Required by ECJ (Eclipse)

 /**
  * Provides Base32 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 behavior of the Base32InputStream is to DECODE, whereas the default behavior of the Base32OutputStream is to ENCODE, but this behavior can be
  * overridden by using a different constructor.
  * </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>
  * <p>
  * You can set the decoding behavior when the input bytes contain leftover trailing bits that cannot be created by a valid encoding. These can be bits that are
  * unused from the final character or entire characters. The default mode is lenient decoding.
  * </p>
  * <ul>
  * <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
  * <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
  * character must be zero. Impossible counts of entire final characters are not allowed.</li>
  * </ul>
  * <p>
  * When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on
  * the final character. This requires that the input bytes use the same padding and alphabet as the encoder.
  * </p>
  *
  * @see Base32
  * @see <a href="https://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
  * @since 1.5
  */
 public class Base32InputStream extends BaseNCodecInputStream<Base32, Base32InputStream, Base32InputStream.Builder> {

     /**
      * Builds instances of Base32InputStream.
      *
      * @since 1.20.0
      */
     public static class Builder extends AbstracBuilder<Base32InputStream, Base32, Builder> {

         /**
          * Constructs a new instance.
          */
         public Builder() {
             // empty
         }

         @Override
         public Base32InputStream get() {
             return new Base32InputStream(this);
         }

         @Override
         protected Base32 newBaseNCodec() {
             return new Base32();
         }
     }

     /**
      * Constructs a new Builder.
      *
      * @return A new Builder.
      * @since 1.20.0
      */
     public static Builder builder() {
         return new Builder();
     }

     private Base32InputStream(final Builder builder) {
         super(builder);
     }

     /**
      * Constructs a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
      *
      * @param inputStream InputStream to wrap.
      */
     public Base32InputStream(final InputStream inputStream) {
         super(builder().setInputStream(inputStream));
     }

     /**
      * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.
      *
      * @param inputStream InputStream to wrap.
      * @param encode    true if we should encode all data read from us, false if we should decode.
      * @deprecated Use {@link #builder()} and {@link Builder}.
      */
     @Deprecated
     public Base32InputStream(final InputStream inputStream, final boolean encode) {
         super(builder().setInputStream(inputStream).setEncode(encode));
     }

     /**
      * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.
      *
      * @param inputStream   InputStream to wrap.
      * @param encode      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 the nearest multiple of 4). If
      *                      lineLength &lt;= 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 (for example \r\n). If lineLength &lt;= 0,
      *                      the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
      * @deprecated Use {@link #builder()} and {@link Builder}.
      */
     @Deprecated
     public Base32InputStream(final InputStream inputStream, final boolean encode, final int lineLength, final byte[] lineSeparator) {
         super(builder().setInputStream(inputStream).setEncode(encode)
                 .setBaseNCodec(Base32.builder().setLineLength(lineLength).setLineSeparator(lineSeparator).get()));
     }

     /**
      * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.
      *
      * @param inputStream    InputStream to wrap.
      * @param encode       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 the nearest multiple of 4). If
      *                       lineLength &lt;= 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 (for example \r\n). If lineLength &lt;=
      *                       0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
      * @param decodingPolicy The decoding policy.
      * @since 1.15
      * @deprecated Use {@link #builder()} and {@link Builder}.
      */
     @Deprecated
     public Base32InputStream(final InputStream inputStream, final boolean encode, final int lineLength, final byte[] lineSeparator,
             final CodecPolicy decodingPolicy) {
         super(builder().setInputStream(inputStream).setEncode(encode)
                 .setBaseNCodec(Base32.builder().setLineLength(lineLength).setLineSeparator(lineSeparator).setDecodingPolicy(decodingPolicy).get()));
     }
 }
	/*
	* 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
	*
	* https://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;

	import org.apache.commons.codec.CodecPolicy;
	import org.apache.commons.codec.binary.BaseNCodecInputStream.AbstracBuilder; // NOPMD: Required by ECJ (Eclipse)

	/**
	* Provides Base32 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 behavior of the Base32InputStream is to DECODE, whereas the default behavior of the Base32OutputStream is to ENCODE, but this behavior can be
	* overridden by using a different constructor.
	* </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>
	* <p>
	* You can set the decoding behavior when the input bytes contain leftover trailing bits that cannot be created by a valid encoding. These can be bits that are
	* unused from the final character or entire characters. The default mode is lenient decoding.
	* </p>
	* <ul>
	* <li>Lenient: Any trailing bits are composed into 8-bit bytes where possible. The remainder are discarded.</li>
	* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if trailing bits are not part of a valid encoding. Any unused bits from the final
	* character must be zero. Impossible counts of entire final characters are not allowed.</li>
	* </ul>
	* <p>
	* When strict decoding is enabled it is expected that the decoded bytes will be re-encoded to a byte array that matches the original, i.e. no changes occur on
	* the final character. This requires that the input bytes use the same padding and alphabet as the encoder.
	* </p>
	*
	* @see Base32
	* @see <a href="https://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
	* @since 1.5
	*/
	public class Base32InputStream extends BaseNCodecInputStream<Base32, Base32InputStream, Base32InputStream.Builder> {

	/**
	* Builds instances of Base32InputStream.
	*
	* @since 1.20.0
	*/
	public static class Builder extends AbstracBuilder<Base32InputStream, Base32, Builder> {

	/**
	* Constructs a new instance.
	*/
	public Builder() {
	// empty
	}

	@Override
	public Base32InputStream get() {
	return new Base32InputStream(this);
	}

	@Override
	protected Base32 newBaseNCodec() {
	return new Base32();
	}
	}

	/**
	* Constructs a new Builder.
	*
	* @return A new Builder.
	* @since 1.20.0
	*/
	public static Builder builder() {
	return new Builder();
	}

	private Base32InputStream(final Builder builder) {
	super(builder);
	}

	/**
	* Constructs a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
	*
	* @param inputStream InputStream to wrap.
	*/
	public Base32InputStream(final InputStream inputStream) {
	super(builder().setInputStream(inputStream));
	}

	/**
	* Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.
	*
	* @param inputStream InputStream to wrap.
	* @param encode true if we should encode all data read from us, false if we should decode.
	* @deprecated Use {@link #builder()} and {@link Builder}.
	*/
	@Deprecated
	public Base32InputStream(final InputStream inputStream, final boolean encode) {
	super(builder().setInputStream(inputStream).setEncode(encode));
	}

	/**
	* Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.
	*
	* @param inputStream InputStream to wrap.
	* @param encode 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 the 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 (for example \r\n). If lineLength <= 0,
	* the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
	* @deprecated Use {@link #builder()} and {@link Builder}.
	*/
	@Deprecated
	public Base32InputStream(final InputStream inputStream, final boolean encode, final int lineLength, final byte[] lineSeparator) {
	super(builder().setInputStream(inputStream).setEncode(encode)
	.setBaseNCodec(Base32.builder().setLineLength(lineLength).setLineSeparator(lineSeparator).get()));
	}

	/**
	* Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original provided InputStream.
	*
	* @param inputStream InputStream to wrap.
	* @param encode 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 the 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 (for example \r\n). If lineLength <=
	* 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
	* @param decodingPolicy The decoding policy.
	* @since 1.15
	* @deprecated Use {@link #builder()} and {@link Builder}.
	*/
	@Deprecated
	public Base32InputStream(final InputStream inputStream, final boolean encode, final int lineLength, final byte[] lineSeparator,
	final CodecPolicy decodingPolicy) {
	super(builder().setInputStream(inputStream).setEncode(encode)
	.setBaseNCodec(Base32.builder().setLineLength(lineLength).setLineSeparator(lineSeparator).setDecodingPolicy(decodingPolicy).get()));
	}
	}