com.kuka.nav.fleet.graph.properties
Annotation Type EditableParameter


@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface EditableParameter

Annotation to mark a field of a class to be editable in an abstract way. To be fully usable by the EditableParameterAccess, classes using such fields must declare getter and setter methods for each field, using the name given in "accessorName". For example:

 @EditableParameter(accessorName = "Length", description = "...")
 private Double _value;
 
 public void setLength(Double x) {...}
 public Double getLength() {...}
 
Primitive types are not possible, use the class variants instead. If abstract construction is desired, a parameterless constructor must be provided.


Required Element Summary
 String accessorName
          Name of the methods to get and set this parameter.
 
Optional Element Summary
 String defaultValue
          The defaultValue which should be set at the beginning or if a seeded value is removed.
 String nullable
          nullable defines null is allowed (true) or not allowed (false)
 String range
          The allowed range for this parameter.
 

Element Detail

accessorName

public abstract String accessorName
Name of the methods to get and set this parameter. If the accessorName is "Value", then the getter must be called "getValue" and the setter "setValue".

range

public abstract String range
The allowed range for this parameter.

Default:
"null"

defaultValue

public abstract String defaultValue
The defaultValue which should be set at the beginning or if a seeded value is removed. If no value is defined a data type depending value will be set, e.g. for a string it is the empty string and for numbers it is 0.

Default:
""

nullable

public abstract String nullable
nullable defines null is allowed (true) or not allowed (false)

Returns:
"false" or "true"
Default:
"false"


Copyright © 2019. All rights reserved.