Codec.java

package org.myrobotlab.codec;

import java.io.OutputStream;

/**
 * Allows a common encoding/decoding interface for dynamic switching between
 * formats. Supports stream and non-stream systems although the codec behind it
 * may not be designed for one or the other
 * 
 * @author GroG
 *
 */
public interface Codec {

  public void encode(OutputStream out, Object obj) throws Exception;

  /**
   * Very important for message decoding where a parameters need decoding. Our
   * system needs to be able to decode an "Array" of parameters - not just one
   * so this method exists to handle that detail.
   * 
   * e.g. URI POST --to--> Message
   * 
   * @param data
   * @return
   * @throws Exception
   */
  public Object[] decodeArray(Object data) throws Exception;

  /**
   * basic decoding method - probably too basic - I currently have only an
   * "Object" input and this certainly won't be the preferred object for many
   * codecs. But you got to start with something :)
   * 
   * @param data
   *          - simple or low level input class - String, byte[]
   * @param type
   *          - the expected type we want to decode into
   * @return
   * @throws Exception
   */
  public Object decode(Object data, Class<?> type) throws Exception;

  /**
   * get mime type of codec if it exists
   * 
   * @return
   */
  public String getMimeType();

  /**
   * different strategies of encoding may in the end have the same mime type so
   * a key is needed to identify the exact type
   * 
   * @return
   */

  public String getKey();

}