Package repast.simphony.ui.probe

Annotation Interface ProbedProperty

@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface ProbedProperty
Marks an accessor type method as a Property that should show up when an instance of the class containing it is probed.
Version:
$Revision$ $Date$
Author:
Nick Collier

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    converter
    Gets the fully qualififed name of class used to convert the return value of the annotated method to and from a String representation.
    String
    displayName
    The proper natural language name for this property.
    String
    usageName
    Gets java bean style property name for this property.

  • Element Details

    • displayName

      String displayName
      The proper natural language name for this property. For example, "Simple Agent Count" rather than something like "simpleAgentCount."
      Returns:
      proper natural language name for this property.
      Default:
      ""

    • usageName

      String usageName
      Gets java bean style property name for this property. For example, if this annotates a "getFoo" method, then the property name is "foo."
      Returns:
      java bean style property name for this property.
      Default:
      ""

    • converter

      String converter
      Gets the fully qualififed name of class used to convert the return value of the annotated method to and from a String representation. The class must implement repast.simphony.parameter.StringConvertor. This is only necessary if the return type is not a String, a primitive value, or one of the Object representatons of a primitive (e.g. an Integer, or Boolean).
      Returns:
      Gets the convertor used to convert the return value of the annotated method to and from a String representation.
      Default:
      ""