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 encoding methods for byte array encoders.
     22  *
     23  * @version $Id: BinaryEncoder.java 651573 2008-04-25 11:11:21Z niallp $
     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 
     42