Package se.diabol.jenkins.pipeline.model

Record Class ViewModel

java.lang.Object
java.lang.Record
se.diabol.jenkins.pipeline.model.ViewModel
@ExportedBean(defaultVisibility=100) public record ViewModel(List<Component> components, ViewSettings settings) extends Record
What the view's api/json serves: the components and the settings. It is exported once per model and viewer and kept with the cached model; the server time is written into every response after it.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ViewModel(List<Component> components, ViewSettings settings)
    Creates an instance of a ViewModel record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Component>
    components()
    Returns the value of the components record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    ViewSettings
    settings()
    Returns the value of the settings record component.
    byte[]
    toJson()
    The JSON of the model as Stapler exports it at the default depth, without a trailing newline.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ViewModel

      public ViewModel(List<Component> components, ViewSettings settings)
      Creates an instance of a ViewModel record class.
      Parameters:
      components - the value for the components record component
      settings - the value for the settings record component

  • Method Details

    • toJson

      public byte[] toJson() throws IOException
      The JSON of the model as Stapler exports it at the default depth, without a trailing newline.
      Throws:
      IOException

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • components

      @Exported public List<Component> components()
      Returns the value of the components record component.
      Returns:
      the value of the components record component

    • settings

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