Milyn-Smooks Version 0.4

org.milyn.cdr
Class ParameterDecoder

java.lang.Object
  extended byorg.milyn.cdr.ParameterDecoder
All Implemented Interfaces:
ContentDeliveryUnit

public abstract class ParameterDecoder
extends java.lang.Object
implements ContentDeliveryUnit

Abstract Parameter Decoder.

Decodes a parameter String value to an Object. The actual decoded Object type depends on the implementation.

Author:
tfennelly

Constructor Summary
ParameterDecoder(CDRDef cdrDef)
          Parameter Decoder Constructor.
 
Method Summary
abstract  java.lang.Object decodeValue(java.lang.String value)
          Decode the supplied parameter value.
 java.lang.String getDetailDescription()
          Get a detail (more verbose) description of the Content Delivery Unit and what it does.
 java.lang.String getShortDescription()
          Get a short description of the Content Delivery Unit and what it does.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterDecoder

public ParameterDecoder(CDRDef cdrDef)
Parameter Decoder Constructor.

Parameters:
cdrDef - cdres Configuration.
Method Detail

decodeValue

public abstract java.lang.Object decodeValue(java.lang.String value)
                                      throws ParameterDecodeException
Decode the supplied parameter value.

Parameters:
value - The value to be decoded.
Returns:
The decode value Object.
Throws:
ParameterDecodeException - Unable to decode parameter value.

getShortDescription

public java.lang.String getShortDescription()
Description copied from interface: ContentDeliveryUnit
Get a short description of the Content Delivery Unit and what it does.

This description will be used as the short description text in UI tools.
Example: "Unclose EMPTY Element"

Note: Implementations of this method should declare this string statically.

Specified by:
getShortDescription in interface ContentDeliveryUnit
Returns:
Short description String.
See Also:
ContentDeliveryUnit.getDetailDescription()

getDetailDescription

public java.lang.String getDetailDescription()
Description copied from interface: ContentDeliveryUnit
Get a detail (more verbose) description of the Content Delivery Unit and what it does.

This description will be used as the detail description text in UI tools.
Example: "Replace element with an unclosed (badly formed!) equivalent if the element contains no content i.e. is empty. This is required by some older useragents."

Note: Implementations of this method should declare this string statically.

Specified by:
getDetailDescription in interface ContentDeliveryUnit
Returns:
Detail description String.
See Also:
ContentDeliveryUnit.getShortDescription()

Milyn-Smooks Version 0.4