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. package org.apache.commons.codec;
  17. /**
  18. * Defines common decoding methods for byte array decoders.
  19. *
  20. * @author Apache Software Foundation
  21. * @version $Id: BinaryDecoder.java,v 1.10 2004/06/15 18:14:15 ggregory Exp $
  22. */
  23. public interface BinaryDecoder extends Decoder {
  24. /**
  25. * Decodes a byte array and returns the results as a byte array.
  26. *
  27. * @param pArray A byte array which has been encoded with the
  28. * appropriate encoder
  29. *
  30. * @return a byte array that contains decoded content
  31. *
  32. * @throws DecoderException A decoder exception is thrown
  33. * if a Decoder encounters a failure condition during
  34. * the decode process.
  35. */
  36. byte[] decode(byte[] pArray) throws DecoderException;
  37. }