org.objectweb.dream.message.codec
Interface CodecManager

All Known Implementing Classes:
BasicCodecManagerImpl

public interface CodecManager

Component insterface that manage dynamic codecs. Each codec is identified with a codec name.


Field Summary
static String ITF_NAME
          The default name of interface of this type.
 
Method Summary
 void addCodec(String codecName, Object hints)
          Adds a codec component for the specified codec name.
 Component getCodec(String codecName)
          Returns the codec component for the given codec name.
 void removeCodec(String codecName)
          Removes a codec component.
 

Field Detail

ITF_NAME

public static final String ITF_NAME
The default name of interface of this type.

See Also:
Constant Field Values
Method Detail

addCodec

public void addCodec(String codecName,
                     Object hints)
              throws CodecManagerException
Adds a codec component for the specified codec name. If a codec component for the given codec name is already present, this method do nothig.

Parameters:
codecName - the name of the codec.
hints - additional parameters.
Throws:
CodecManagerException - if the manager can't add the codec.

removeCodec

public void removeCodec(String codecName)
                 throws CodecManagerException
Removes a codec component. The codec component must not be in use (i.e. the component is not shared by different composites).

Parameters:
codecName - the name of the codec.
Throws:
CodecManagerException - the the given codec name is unknown, or if the codec component is in use.

getCodec

public Component getCodec(String codecName)
                   throws CodecManagerException
Returns the codec component for the given codec name.

Parameters:
codecName - the name of the codec.
Returns:
the codec component for the given codec name.
Throws:
CodecManagerException - the the given codec name is unknown.


Copyright © 2003, 2004 - INRIA Rhone-Alpes - All Rights Reserved.