Module neberus.core
Package net.oneandone.neberus.annotation

Annotation Type ApiHeaderDefinition

  • @Target(TYPE)
@Retention(SOURCE)
@Repeatable(ApiHeaderDefinitions.class)
@Inherited
public @interface ApiHeaderDefinition
    Define a Header on class level, this can be used to provided descriptions of headers that are reused many times. The header name will be used for reference.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      Name of the header.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      Description of the header.

    • Element Detail

      • name

        java.lang.String name
        Name of the header. May be used on a method to reference a header defined on the class.
        Returns:
        the name

      • description

        java.lang.String description
        Description of the header.
        Returns:
        the description
        Default:
        ""