Home | History | Annotate | Download | only in codec
      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;
     19 
     20 /**
     21  * Defines common decoding methods for byte array decoders.
     22  *
     23  * @author Apache Software Foundation
     24  * @version $Id: BinaryDecoder.java 651573 2008-04-25 11:11:21Z niallp $
     25  */
     26 public interface BinaryDecoder extends Decoder {
     27 
     28     /**
     29      * Decodes a byte array and returns the results as a byte array.
     30      *
     31      * @param pArray A byte array which has been encoded with the
     32      *      appropriate encoder
     33      *
     34      * @return a byte array that contains decoded content
     35      *
     36      * @throws DecoderException A decoder exception is thrown
     37      *          if a Decoder encounters a failure condition during
     38      *          the decode process.
     39      */
     40     byte[] decode(byte[] pArray) throws DecoderException;
     41 }
     42 
     43