Package org.glassfish.config.support

Annotation Interface ListingColumn

@Retention(RUNTIME) @Target(METHOD) public @interface ListingColumn
List command column annotation.

>This annotation works with the Listing annotation to provide additional information about columns in the output. The annotation can be placed on any method that takes no arguments and returns a type that can be converted to a String, including default methods.

Author:
Tom Mueller

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    exclude
    Determines whether a column should be excluded from the output.
    String
    header
    Returns the header for the column.
    boolean
    inLongByDefault
    Determines whether a column should be included in the --long output by default.
    int
    order
    Determines the order of the columns from left to right.

  • Element Details

    • order

      int order
      Determines the order of the columns from left to right. The "key" attribute is assigned order value 0. Higher order values are for columns further to the right.
      Default:
      1

    • header

      String header
      Returns the header for the column. The calculated value is the method name converted to XML form, e.g., getSomeAttr is SOME-ATTR
      Default:
      ""

    • exclude

      boolean exclude
      Determines whether a column should be excluded from the output. The default is false.
      Default:
      false

    • inLongByDefault

      boolean inLongByDefault
      Determines whether a column should be included in the --long output by default. The default is true.
      Default:
      true