Package io.jenkins.plugins.livewall

Interface WallOption

All Known Implementing Classes:
Packing, Palette, Sizing, SortBy, StatusScope, TileAnimation, TileShape
public interface WallOption
Common contract for the small enums that make up a wall's look: each constant has a stable id that survives config round-trips (and shows up in CSS as a data- attribute) plus a human label for the drop-downs.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayName()
    Label shown in the view configuration form, where there is room to explain the choice.
    String
    getId()
    Stable, lowercase, kebab-case id.
    default String
    getShortName()
    The label without its explanation, for the preview bar, where seven drop-downs share a row and a full sentence in each one is unreadable.
    static <E extends Enum<E> & WallOption>
    ListBoxModel
    items(Class<E> type)
    Builds the drop-down model for a <f:select> over all constants of an option enum.
    static <E extends Enum<E> & WallOption>
    E
    parse(Class<E> type, String id, E fallback)
    Resolves an id back to a constant, falling back to fallback for anything unknown so that a hand-edited config.xml can never break the wall.

  • Method Details

    • getId

      @NonNull String getId()
      Stable, lowercase, kebab-case id. Persisted in config.xml and emitted into the markup.

    • getDisplayName

      @NonNull String getDisplayName()
      Label shown in the view configuration form, where there is room to explain the choice.

    • getShortName

      @NonNull default String getShortName()
      The label without its explanation, for the preview bar, where seven drop-downs share a row and a full sentence in each one is unreadable. Everything before the em dash, if there is one.

    • parse

      static <E extends Enum<E> & WallOption> E parse(Class<E> type, @CheckForNull String id, E fallback)
      Resolves an id back to a constant, falling back to fallback for anything unknown so that a hand-edited config.xml can never break the wall.

    • items

      static <E extends Enum<E> & WallOption> ListBoxModel items(Class<E> type)
      Builds the drop-down model for a <f:select> over all constants of an option enum.