org.diirt.service

Class ServiceMethodDescription

java.lang.Object

org.diirt.service.ServiceMethodDescription

Direct Known Subclasses:

ExecServiceMethodDescription, JDBCServiceMethodDescription, RPCServiceMethodDescription

public abstract class ServiceMethodDescription
extends Object

A utility class to gather all the elements that define the service method.

This class is not thread-safe and is meant to be used right before the creation of ServiceMethod objects.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ServiceMethodDescription(String name, String description) Creates a new service method description with the given name and description, both of which are mandatory attributes of the service methods.

Method Summary

Modifier and Type	Method and Description
ServiceMethodDescription	addArgument(String name, String description, Class<?> type) Adds an argument for this method, with the given name, description and type.
ServiceMethodDescription	addResult(String name, String description, Class<?> type) Adds a result for this method, with the given name, description and type.
abstract ServiceMethod	createServiceMethod(ServiceDescription serviceDescription) Creates a service method with the given description.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceMethodDescription

public ServiceMethodDescription(String name,
                                String description)

Creates a new service method description with the given name and description, both of which are mandatory attributes of the service methods.

Parameters:

name - the service method name, can't be null or empty

description - the service method description, can't be null or empty

Method Detail

addArgument

public ServiceMethodDescription addArgument(String name,
                                            String description,
                                            Class<?> type)

Adds an argument for this method, with the given name, description and type. The order in which arguments are added is retained as the preferred order of arguments for the service method.

Parameters:

name - a short argument name; can't be null or empty

description - a meaningful description; can't be null or empty

type - the type of the argument

Returns:

this description

addResult

public ServiceMethodDescription addResult(String name,
                                          String description,
                                          Class<?> type)

Adds a result for this method, with the given name, description and type. The order in which results are added is retained as the preferred order of arguments for the service method.

Parameters:

name - a short result name; can't be null

description - a meaningful description; can't be null

type - the type of the result

Returns:

this description

createServiceMethod

public abstract ServiceMethod createServiceMethod(ServiceDescription serviceDescription)

Creates a service method with the given description.

A client should implement this to return their service method implementation.

Parameters:

serviceDescription - service description for the new service method

Returns:

a new service method