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 encoding methods for byte array encoders.

  21.  * 

  22.  * @author Apache Software Foundation

  23.  * @version $Id: BinaryEncoder.java,v 1.10 2004/02/29 04:08:31 tobrien Exp $

  24.  */

  25. public interface BinaryEncoder extends Encoder {

  26.     

  27.     /**

  28.      * Encodes a byte array and return the encoded data

  29.      * as a byte array.

  30.      * 

  31.      * @param pArray Data to be encoded

  32.      *

  33.      * @return A byte array containing the encoded data

  34.      * 

  35.      * @throws EncoderException thrown if the Encoder

  36.      *      encounters a failure condition during the

  37.      *      encoding process.

  38.      */

  39.     byte[] encode(byte[] pArray) throws EncoderException;

  40. }  

  41.