• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2001-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package org.apache.commons.codec;
18 
19 /**
20  * Defines common decoding methods for byte array decoders.
21  *
22  * @author Apache Software Foundation
23  * @version $Id: BinaryDecoder.java,v 1.10 2004/06/15 18:14:15 ggregory Exp $
24  */
25 public interface BinaryDecoder extends Decoder {
26 
27     /**
28      * Decodes a byte array and returns the results as a byte array.
29      *
30      * @param pArray A byte array which has been encoded with the
31      *      appropriate encoder
32      *
33      * @return a byte array that contains decoded content
34      *
35      * @throws DecoderException A decoder exception is thrown
36      *          if a Decoder encounters a failure condition during
37      *          the decode process.
38      */
decode(byte[] pArray)39     byte[] decode(byte[] pArray) throws DecoderException;
40 }
41 
42