11.25 Parameter Object
| Used on |
|
| Description | 'parameter' is used to pass values into a method call.
This is 'parameter' in the business object model, which accepts constraints on the parameters value and allows the definition of the collection-element-type.
|
Contained
Lists |
| 1 |
| Name | annotation |
| Type | String |
| Description | An optional list, comma-separated, of Java annotations.
You can put the '@' as the first character on the annotation, but it is not necessary.
You can add the annotation as either
- an XML element, with the CDATA being the annotation text
- a property which can contain multiple annotations, comma-separated.
If you use the property form, you cannot add multiple element-pair values as the syntax conflicts with the comma-separation syntax.
In other words, annotation="@Annotation(id=27,name='Fred')" will be parsed into two separate annotations,
and then inserted into the code as "@Annotation(id=27" and "@name='Fred')", which is incorrect syntax.
Because of this, some modelling environments allow annotations to be added as a property (this is most convenient) and as a list (this allows complex annotations).
|
| Unique | false |
|
|
Inherited
properties |
|
11.25.1 Property 'badValue'
|
| Description | An unacceptable value for this parameter.
This can be used by test software to create test records automatically.
|
| Type | String |
11.25.2 Property 'description'
|
| Description | Optional description.
Use this to
- document the meaning of a particular item
- specify functionality at the design stage for implementation later.
|
| Type | String |
11.25.3 Property 'final'
|
| Description | This is the Java 'final' attribute.
There are two methods for reading this out, for use on a field or on a class, because these have different names in CSharp.
The generic 'getFinalText()' is used on parameters in Java.
|
| Type | boolean |
| Default | false |
11.25.4 Property 'goodValue'
|
| Description | An acceptable value for this parameter.
This can be used by test software to create test records automatically.
|
| Type | String |
11.25.5 Property 'name'
|
| Description | Specifies the identifier for the field or parameter. This must follow the rules for identifiers (start with a letter or '_', not include '.' etc.).
|
| Type | String |
| Required | true |
11.25.6 Property 'type'
|
| Description | Specifies the object type and may be the name of a primitive type or a class.
If the type is a class and the code requires you to qualify it (because it is ambiguous in one or more compiled files) you will have to add the qualifying package information yourself.
To specify an array, add '[]' on the end of the type, just as you would in a normal array declaration.
|
| Type | String |
| Default | String |
|
