Package com.atlassian.gadgets.dashboard

Class DashboardState.Builder

java.lang.Object
com.atlassian.gadgets.dashboard.DashboardState.Builder
Enclosing class:
DashboardState
public static class DashboardState.Builder extends Object
A builder that allows the Layout or the columns of the DashboardState under construction to be set. Creating the final DashboardState is done by calling the build() method.

  • Method Details

    • layout

      public DashboardState.Builder layout(Layout layout)
      Set the Layout of the DashboardState under construction and return this Builder to allow further construction to be done.
      Parameters:
      layout - the Layout to use for the DashboardState
      Returns:
      this builder to allow for further construction

    • title

      public DashboardState.Builder title(String title)
      Set the title of the DashboardState under construction and return this Builder to allow further construction to be done.
      Parameters:
      title - the title to use for the DashboardState
      Returns:
      this builder to allow for further construction

    • columns

      @Deprecated public DashboardState.Builder columns(Iterable<? extends Iterable<GadgetState>> columns)
      Deprecated.
      Set the columns of the DashboardState under construction and return this Builder to allow further construction to be done.
      Parameters:
      columns - an Iterable list of GadgetState objects
      Returns:
      this builder to allow for further construction deprecated Use dashboardColumns(java.lang.Iterable<? extends java.lang.Iterable<com.atlassian.gadgets.DashboardItemState>>) instead. Since v3.11.

    • dashboardColumns

      public DashboardState.Builder dashboardColumns(Iterable<? extends Iterable<DashboardItemState>> columns)
      Set the columns of the DashboardState under construction and return this Builder to allow further construction to be done.
      Parameters:
      columns - an Iterable list of GadgetState objects
      Returns:
      this builder to allow for further construction

    • version

      public DashboardState.Builder version(long version)
      Set the version of the DashboardState under construction and return this Builder to allow further construction to be done.
      Parameters:
      version - the version of this DashboardState object
      Returns:
      this builder to allow for further construction

    • build

      public DashboardState build()
      Returns the final constructed DashboardState
      Returns:
      the DashboardState