Package io.jenkins.plugins.checks.api

Class ChecksImage

java.lang.Object

io.jenkins.plugins.checks.api.ChecksImage

public class ChecksImage
extends Object

An image of a check. Users may use a image to show the code coverage, issues trend, etc.

Constructor Summary

Constructors

Constructor	Description
ChecksImage(String alt, String imageURL, String caption)	Constructs an image with all parameters.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAlt()	Returns the alternative text for the image.
Optional<String>	getCaption()	Returns the short description of the image.
Optional<String>	getImageUrl()	Returns the image URL.
Optional<String>	getImageURL()	Returns the image URL.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ChecksImage

public ChecksImage(@CheckForNull
 String alt,
 @CheckForNull
 String imageURL,
 @CheckForNull
 String caption)

Constructs an image with all parameters.

Parameters:

alt - the alternative text for the image

imageURL - the full URL of the image

caption - a short description of the image

Method Details

getAlt

public Optional<String> getAlt()

Returns the alternative text for the image.

Returns:

the alternative text for the image

getImageUrl

public Optional<String> getImageUrl()

Returns the image URL. Note: This method will be deprecated after 1.0.0, use getImageURL() instead.

Returns:

the image URL

getImageURL

public Optional<String> getImageURL()

Returns the image URL.

Returns:

the image URL

getCaption

public Optional<String> getCaption()

Returns the short description of the image.

Returns:

the short description of the image

toString

public String toString()

Overrides:

toString in class Object