Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Not only are the annotations useful for automatically generating the documentation; we can use them to refine the validation of the code during configuration and they can be useful for tool providers so they can more easily introspect the configuration options. See the ComponentConfiguration documentation on the tooling aspect.

Using the UriEndpointComponent base class

If you use the @UriEndpoint annotation on your Endpoint along with one or more @UriParam / @UriParams annotations on your class (or any base classes of your endpoint) its recommended that your Component class inherit from the UriEndpointComponent base class as that means your Component will automatically generate better metadata for the ComponentConfiguration API.

This will allow your component to work better inside tools which make use of the ComponentConfiguration API to generate nice forms and so forth.