net.sf.mmm.util.cli.base

Class CliClassContainer.CliModeFormatter

java.lang.Object

net.sf.mmm.util.cli.base.CliClassContainer.CliModeFormatter

All Implemented Interfaces:

SimpleValueConverter<CliModeContainer,String>

Enclosing class:

CliClassContainer

protected static final class CliClassContainer.CliModeFormatter
extends Object
implements SimpleValueConverter<CliModeContainer,String>

This inner class converts a CliModeContainer to a String.

Field Summary

Fields

Modifier and Type	Field and Description
private static CliClassContainer.CliModeFormatter	INSTANCE The singleton instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CliModeFormatter()

Method Summary

Modifier and Type	Method and Description
<T extends String> T	convert(CliModeContainer value, Object valueSource, Class<T> targetClass) This method converts the given pojo to the <TARGET>-type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

private static final CliClassContainer.CliModeFormatter INSTANCE

The singleton instance.

Constructor Detail

CliModeFormatter

protected CliModeFormatter()

Method Detail

convert

public <T extends String> T convert(CliModeContainer value,
                                    Object valueSource,
                                    Class<T> targetClass)
                             throws ValueException

This method converts the given pojo to the <TARGET>-type.

Specified by:

convert in interface SimpleValueConverter<CliModeContainer,String>

Type Parameters:

T - is the generic type of targetClass.

Parameters:

value - is the value to convert.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

targetClass - is the type to convert the value to.

Returns:

the converted value or null if the conversion is NOT possible. The returned value has to be an instance of the given targetType.

Throws:

ValueException - if the conversion failed (e.g. the given value is illegal for the given targetClass).