de.intarsys.tools.functor

Class ResultTools

java.lang.Object

de.intarsys.tools.functor.ResultTools

public class ResultTools
extends Object

A tool class for handling "result" objects.

The result args contain information on the result requested for a service.

 result = {
                return = "void" | "primitive" | "composite";
                property = {
                         = {
                                return = "true" | "false";
                                style = "literal" | "reference";
                                display = "true" | "false";
                        }
                        ...
                }
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARG_RESULT
static String	ARG_RESULT_PROPERTY
static String	ARG_RESULT_RETURN
static String	PROP_DISPLAY
static String	PROP_RETURN
static String	PROP_STYLE

Constructor Summary

Constructors

Constructor and Description
ResultTools()

Method Summary

Methods

Modifier and Type	Method and Description
static IArgs	getPropertyDescriptor(IArgs args, String name)
static Map<String,IArgs>	getPropertyDescriptors(IArgs args)
static EnumStyle	getPropertyStyle(IArgs propertyDescriptor, EnumStyle defaultValue)
static EnumStyle	getPropertyStyle(IArgs args, String name, EnumStyle defaultValue)
static IArgs	getResultDescriptor(IArgs args)
static EnumReturnMode	getResultReturnMode(IArgs args)
static boolean	isPropertyDescriptor(IArgs args)
static boolean	isPropertyDescriptorProperty(String name)
static boolean	isPropertyDisplay(IArgs propertyDescriptor, boolean defaultValue)
static boolean	isPropertyDisplay(IArgs args, String name, boolean defaultValue)
static boolean	isPropertyReturn(IArgs propertyDescriptor, boolean defaultValue)
static boolean	isPropertyReturn(IArgs args, String name, boolean defaultValue)

Methods inherited from class java.lang.Object

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

Field Detail

ARG_RESULT

public static final String ARG_RESULT

See Also:

Constant Field Values

ARG_RESULT_RETURN

public static final String ARG_RESULT_RETURN

See Also:

Constant Field Values

ARG_RESULT_PROPERTY

public static final String ARG_RESULT_PROPERTY

See Also:

Constant Field Values

PROP_STYLE

public static final String PROP_STYLE

See Also:

Constant Field Values

PROP_RETURN

public static final String PROP_RETURN

See Also:

Constant Field Values

PROP_DISPLAY

public static final String PROP_DISPLAY

See Also:

Constant Field Values

Constructor Detail

ResultTools

public ResultTools()

Method Detail

getPropertyDescriptor

public static IArgs getPropertyDescriptor(IArgs args,
                          String name)

getPropertyDescriptors

public static Map<String,IArgs> getPropertyDescriptors(IArgs args)

getPropertyStyle

public static EnumStyle getPropertyStyle(IArgs propertyDescriptor,
                         EnumStyle defaultValue)

getPropertyStyle

public static EnumStyle getPropertyStyle(IArgs args,
                         String name,
                         EnumStyle defaultValue)

getResultDescriptor

public static IArgs getResultDescriptor(IArgs args)

getResultReturnMode

public static EnumReturnMode getResultReturnMode(IArgs args)

isPropertyDescriptor

public static boolean isPropertyDescriptor(IArgs args)

isPropertyDescriptorProperty

public static boolean isPropertyDescriptorProperty(String name)

isPropertyDisplay

public static boolean isPropertyDisplay(IArgs propertyDescriptor,
                        boolean defaultValue)

isPropertyDisplay

public static boolean isPropertyDisplay(IArgs args,
                        String name,
                        boolean defaultValue)

isPropertyReturn

public static boolean isPropertyReturn(IArgs propertyDescriptor,
                       boolean defaultValue)

isPropertyReturn

public static boolean isPropertyReturn(IArgs args,
                       String name,
                       boolean defaultValue)