Package org.apache.juneau.marshall.html

Annotation Interface HtmlLink

@Documented @Target(TYPE) @Retention(RUNTIME) @Inherited public @interface HtmlLink
Used in conjunction with the HtmlSerializer class to define hyperlinks.

Can be used in the following locations:

  • Classes.
  • @Rest-annotated classes and @RestOp-annotated methods when used with @HtmlLinkApply.

Annotation that can be used to specify that a class has a URL associated with it.

When rendered using the HtmlSerializer class, this class will get rendered as a hyperlink like so...

<a href='hrefProperty'>nameProperty</a>

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    description
    Optional description for the exposed API.
    String
    nameProperty
    The bean property whose value becomes the name in the hyperlink.
    String
    uriProperty
    The bean property whose value becomes the url in the hyperlink.

  • Element Details

    • description

      String[] description
      Optional description for the exposed API.
      Returns:
      The annotation value.
      Since:
      9.2.0
      Default:
      {}

    • nameProperty

      String nameProperty
      The bean property whose value becomes the name in the hyperlink.
      Returns:
      The annotation value.
      Default:
      "name"

    • uriProperty

      String uriProperty
      The bean property whose value becomes the url in the hyperlink.
      Returns:
      The annotation value.
      Default:
      "uri"