Package io.jenkins.plugins.prism

Class Marker.MarkerBuilder

java.lang.Object
io.jenkins.plugins.prism.Marker.MarkerBuilder
Enclosing class:
Marker
public static class Marker.MarkerBuilder extends Object
Creates markers using the builder pattern.
Author:
Ullrich Hafner

  • Constructor Details

    • MarkerBuilder

      public MarkerBuilder()

  • Method Details

    • withTitle

      public Marker.MarkerBuilder withTitle(String title)
      Defines the title of the marker. This title must not contain HTML tags.
      Parameters:
      title - the title, should fit into a single line
      Returns:
      this builder

    • withIcon

      public Marker.MarkerBuilder withIcon(String icon)
      Defines the icon of the marker.
      Parameters:
      icon - the icon (if available use an SVG icon)
      Returns:
      this builder

    • withDescription

      public Marker.MarkerBuilder withDescription(String description)
      Defines the title of the marker.
      Parameters:
      description - the detailed description of the maker. This description may contain valid HTML elements.
      Returns:
      this builder

    • withLineStart

      public Marker.MarkerBuilder withLineStart(int lineStart)
      Defines the first line of this marker (lines start at 1; 0 indicates the whole file).
      Parameters:
      lineStart - the first line
      Returns:
      this builder

    • withLineEnd

      public Marker.MarkerBuilder withLineEnd(int lineEnd)
      Defines the last line of this marker (lines start at 1).
      Parameters:
      lineEnd - the last line
      Returns:
      this builder

    • withColumnStart

      public Marker.MarkerBuilder withColumnStart(int columnStart)
      Defines the first column of this marker (columns start at 1, 0 indicates the whole line).
      Parameters:
      columnStart - the first column
      Returns:
      this builder

    • withColumnEnd

      public Marker.MarkerBuilder withColumnEnd(int columnEnd)
      Defines the last column of this marker (columns start at 1).
      Parameters:
      columnEnd - the last column
      Returns:
      this builder

    • build

      public Marker build()
      Creates an immutable Marker instance using the configured properties.
      Returns:
      the new annotation