Parameter (MMBase 1.9-SNAPSHOT

java.lang.Object
- org.mmbase.core.AbstractDescriptor
- - org.mmbase.util.functions.Parameter<C>

All Implemented Interfaces:

Serializable, Cloneable, Descriptor, PublicCloneable<AbstractDescriptor>

Direct Known Subclasses:

Parameter.Wrapper, PatternParameter, ReturnType
```
public class Parameter<C>
extends AbstractDescriptor
implements Serializable
```
Each (function) argument is specified by a Parameter object. A Parameter contains a name and type (it does not contain a value). An array of this is returned by Function.getParameterDefinition(), and this same array is used to create new empty Parameters object (by Function.createParameters()), which can contain actual values for each Parameter.

Since:

MMBase-1.7

Version:

$Id$

Author:

Daniel Ockeloen (MMFunctionParam), Michiel Meeuwissen

See Also:

Parameters, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Parameter.Wrapper
A Parameter.Wrapper wraps one Parameter around a Parameter[] (then you can put it in a Parameter[]).

Nested Classes
Modifier and Type	Class and Description
`static class`	`Parameter.Wrapper` A Parameter.Wrapper wraps one Parameter around a Parameter[] (then you can put it in a Parameter[]).

Field Summary

Fields
Modifier and Type	Field and Description
`static Parameter<Cloud>`	`CLOUD`
`static Parameter`	`CORENODE`
`protected DataType<C>`	`dataType` The parameter's data type
`static Parameter[]`	`EMPTY` An empty Parameter array.
`static Parameter<String>`	`FIELD`
`static Parameter<String>`	`LANGUAGE` Parameter which might be needed in lots of Parameter definitions.
`static Parameter<Locale>`	`LOCALE`
`static Parameter<Node>`	`NODE` 'system' parameter set for nodefunctions.
`static Parameter<javax.servlet.http.HttpServletRequest>`	`REQUEST`
`static Parameter<javax.servlet.http.HttpServletResponse>`	`RESPONSE`
`static Parameter<UserContext>`	`USER`

Fields inherited from class org.mmbase.core.AbstractDescriptor
description, guiName, key

Constructor Summary

Constructors
Constructor and Description
`Parameter(Map.Entry<String,C> entry)` Create Parameter definition by example value
`Parameter(Parameter<C> p, boolean required)` Copy-constructor, just to copy it with different requiredness
`Parameter(Parameter<C> p, C defaultValue)` Copy-constructor, just to copy it with different defaultValue (which implies that it is not required now)
`Parameter(String name, C defaultValue)`
`Parameter(String name, Class<C> type)` Create a Parameter object
`Parameter(String name, Class<C> type, boolean required)` Create a Parameter object
`Parameter(String name, Class<C> type, C defaultValue)` Create a Parameter object
`Parameter(String name, DataType<C> dataType)` Create a Parameter object
`Parameter(String name, DataType<C> dataType, boolean copy)` Create a Parameter object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected C`	`autoCast(Object value)` Tries to 'cast' an object for use with this parameter.
`void`	`checkType(Object value)` Checks if the passed object is of the correct class (compatible with the type of this Parameter), and throws an IllegalArgumentException if it doesn't.
`static <C> Parameter<C>[]`	`emptyArray()`
`boolean`	`equals(Object o)` Whether parameter equals to other parameter.
`protected static <C> Class<C>`	`getClass(C v)`
`static Class<?>`	`getClassForName(String type)`
`DataType<C>`	`getDataType()` Returns the data type of this parameter.
`C`	`getDefaultValue()` Returns the default value of this parameter (derived from the datatype).
`Class<C>`	`getTypeAsClass()` Returns the type of values that this parameter accepts.
`int`	`hashCode()`
`boolean`	`isRequired()` Returns whether the parameter requires a value.
`boolean`	`matches(String key)`
`static Parameter<?>[]`	`readArrayFromXml(Element element)`
`static <C> Parameter<C>`	`readFromXml(Element element)`
`void`	`setDefaultValue(C defaultValue)` Sets the default value of this parameter.
`String`	`toString()`

Methods inherited from class org.mmbase.core.AbstractDescriptor
clone, clone, getDefaultLocale, getDescription, getDescription, getGUIName, getGUIName, getLocalizedDescription, getLocalizedGUIName, getName, setDescription, setDescription, setGUIName, setGUIName, setLocalizedDescription, setLocalizedGUIName

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LANGUAGE
```
public static final Parameter<String> LANGUAGE
```
    Parameter which might be needed in lots of Parameter definitions. These parameters are 'standard' parameters, which can be filled in by the system. E.g. the mmbase taglib uses these constants, and if it has a cloud ('mm:cloud is used'), then cloud-parameters are filled automaticly.
  - LOCALE
```
public static final Parameter<Locale> LOCALE
```
  - USER
```
public static final Parameter<UserContext> USER
```
  - RESPONSE
```
public static final Parameter<javax.servlet.http.HttpServletResponse> RESPONSE
```
  - REQUEST
```
public static final Parameter<javax.servlet.http.HttpServletRequest> REQUEST
```
  - CLOUD
```
public static final Parameter<Cloud> CLOUD
```
  - NODE
```
public static final Parameter<Node> NODE
```
    'system' parameter set for nodefunctions.
    
    Since:
    
    MMBase-1.8
  - CORENODE
```
public static final Parameter CORENODE
```
  - FIELD
```
public static final Parameter<String> FIELD
```
  - EMPTY
```
public static final Parameter[] EMPTY
```
    An empty Parameter array.
  - dataType
```
protected DataType<C> dataType
```
    The parameter's data type
    
    Since:
    
    MMBase-1.8
- Constructor Detail
  - Parameter
```
public Parameter(String name,
                 DataType<C> dataType)
```
    Create a Parameter object
    
    Parameters:
    
    name - the name of the parameter
    
    dataType - the datatype of the parameter to copy
    
    Since:
    
    MMBase-1.8
  - Parameter
```
public Parameter(String name,
                 DataType<C> dataType,
                 boolean copy)
```
    Create a Parameter object
    
    Parameters:
    
    name - the name of the parameter
    
    dataType - the datatype of the parameter to assign or copy
    
    copy - if true, teh datatype is copied. if not, it is assigned directly, that is, changing condfiitons on the parameter changes the passed datatype instance.
    
    Since:
    
    MMBase-1.8
  - Parameter
```
public Parameter(String name,
                 Class<C> type)
```
    Create a Parameter object
    
    Parameters:
    
    name - the name of the parameter
    
    type - the class of the parameter's possible value
  - Parameter
```
public Parameter(String name,
                 Class<C> type,
                 boolean required)
```
    Create a Parameter object
    
    Parameters:
    
    name - the name of the parameter
    
    type - the class of the parameter's possible value
    
    required - whether the parameter requires a value
  - Parameter
```
public Parameter(String name,
                 Class<C> type,
                 C defaultValue)
```
    Create a Parameter object
    
    Parameters:
    
    name - the name of the parameter
    
    type - the class of the parameter's possible value
    
    defaultValue - the value to use if the parameter has no value set
  - Parameter
```
public Parameter(String name,
                 C defaultValue)
```
  - Parameter
```
public Parameter(Map.Entry<String,C> entry)
```
    Create Parameter definition by example value
    
    Since:
    
    MMBase-1.9
  - Parameter
```
public Parameter(Parameter<C> p,
                 boolean required)
```
    Copy-constructor, just to copy it with different requiredness
  - Parameter
```
public Parameter(Parameter<C> p,
                 C defaultValue)
```
    Copy-constructor, just to copy it with different defaultValue (which implies that it is not required now)
- Method Detail
  - emptyArray
```
public static <C> Parameter<C>[] emptyArray()
```
  - readArrayFromXml
```
public static Parameter<?>[] readArrayFromXml(Element element)
```
    Since:
    
    MMBase-1.9
  - readFromXml
```
public static <C> Parameter<C> readFromXml(Element element)
```
    Since:
    
    MMBase-1.9
  - getClassForName
```
public static Class<?> getClassForName(String type)
```
    Since:
    
    MMBase-1.9
  - getClass
```
protected static <C> Class<C> getClass(C v)
```
  - getDefaultValue
```
public C getDefaultValue()
```
    Returns the default value of this parameter (derived from the datatype).
    
    Returns:
    
    the default value
  - setDefaultValue
```
public void setDefaultValue(C defaultValue)
```
    Sets the default value of this parameter.
    
    Parameters:
    
    defaultValue - the default value
  - getDataType
```
public DataType<C> getDataType()
```
    Returns the data type of this parameter.
    
    Returns:
    
    the datatype
    
    Since:
    
    MMBase-1.8
  - getTypeAsClass
```
public Class<C> getTypeAsClass()
```
    Returns the type of values that this parameter accepts.
    
    Returns:
    
    the type as a Class
  - isRequired
```
public boolean isRequired()
```
    Returns whether the parameter requires a value.
    
    Returns:
    
    true if a value is required
  - checkType
```
public void checkType(Object value)
```
    Checks if the passed object is of the correct class (compatible with the type of this Parameter), and throws an IllegalArgumentException if it doesn't.
    
    Parameters:
    
    value - the value whose type (class) to check
    
    Throws:
    
    IllegalArgumentException - if the type is not compatible
  - autoCast
```
protected C autoCast(Object value)
              throws CastException
```
    Tries to 'cast' an object for use with this parameter. E.g. if value is a String, but this parameter is of type Integer, then the string can be parsed to Integer.
    
    Parameters:
    
    value - The value to be filled in in this Parameter.
    
    Throws:
    
    CastException
  - matches
```
public boolean matches(String key)
```
    Since:
    
    MMBase-1.9
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Whether parameter equals to other parameter. Only key and type are consided. DefaultValue and required propererties are only 'utilities'.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if o is Parameter of which key and type equal to this' key and type.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractDescriptor

Class Parameter<C>

Nested Class Summary

Field Summary

Fields inherited from class org.mmbase.core.AbstractDescriptor

Constructor Summary

Method Summary

Methods inherited from class org.mmbase.core.AbstractDescriptor

Methods inherited from class java.lang.Object

Field Detail

LANGUAGE

LOCALE

USER

RESPONSE

REQUEST

CLOUD

NODE

CORENODE

FIELD

EMPTY

dataType

Constructor Detail

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Parameter

Method Detail

emptyArray

readArrayFromXml

readFromXml

getClassForName

getClass

getDefaultValue

setDefaultValue

getDataType

getTypeAsClass

isRequired

checkType

autoCast

matches

hashCode

equals

toString