Package se.diabol.jenkins.pipeline.source

Record Class ComponentRequest

java.lang.Object
java.lang.Record
se.diabol.jenkins.pipeline.source.ComponentRequest
Record Components:
name - the component's heading
index - the 1-based position of the component in the view
firstJob - the job the pipeline starts with
lastJob - the job the pipeline ends with, or null to follow the chain to its ends
showUpstream - whether to start the pipeline from the jobs upstream of the first job instead
context - the item group the view belongs to, for resolving relative job names
settings - the view's options
page - the 1-based page of pipeline instances to return when paging is on
paging - whether to page at all (paging is off on full screen pages)
public record ComponentRequest(String name, int index, Job<?,?> firstJob, Job<?,?> lastJob, boolean showUpstream, ItemGroup<?> context, ViewSettings settings, int page, boolean paging) extends Record
What a ComponentSource needs to build one component.

  • Constructor Details

    • ComponentRequest

      public ComponentRequest(String name, int index, Job<?,?> firstJob, Job<?,?> lastJob, boolean showUpstream, ItemGroup<?> context, ViewSettings settings, int page, boolean paging)
      Creates an instance of a ComponentRequest record class.
      Parameters:
      name - the value for the name record component
      index - the value for the index record component
      firstJob - the value for the firstJob record component
      lastJob - the value for the lastJob record component
      showUpstream - the value for the showUpstream record component
      context - the value for the context record component
      settings - the value for the settings record component
      page - the value for the page record component
      paging - the value for the paging record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • index

      public int index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • firstJob

      public Job<?,?> firstJob()
      Returns the value of the firstJob record component.
      Returns:
      the value of the firstJob record component

    • lastJob

      public Job<?,?> lastJob()
      Returns the value of the lastJob record component.
      Returns:
      the value of the lastJob record component

    • showUpstream

      public boolean showUpstream()
      Returns the value of the showUpstream record component.
      Returns:
      the value of the showUpstream record component

    • context

      public ItemGroup<?> context()
      Returns the value of the context record component.
      Returns:
      the value of the context record component

    • settings

      public ViewSettings settings()
      Returns the value of the settings record component.
      Returns:
      the value of the settings record component

    • page

      public int page()
      Returns the value of the page record component.
      Returns:
      the value of the page record component

    • paging

      public boolean paging()
      Returns the value of the paging record component.
      Returns:
      the value of the paging record component