Package io.jenkins.plugins.bootstrap5

Class MessagesViewModel

java.lang.Object

io.jenkins.plugins.bootstrap5.MessagesViewModel

All Implemented Interfaces:

ModelObject

public class MessagesViewModel
extends Object
implements ModelObject

A view model to visualize logging messages and errors of a build step.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor	Description
MessagesViewModel(Run<?,?> owner, String displayName, List<String> infoMessages)	Creates a new MessagesViewModel with info messages only.
MessagesViewModel(Run<?,?> owner, String displayName, List<String> infoMessages, List<String> errorMessages)	Creates a new MessagesViewModel with error and info messages.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
Collection<String>	getErrorMessages()	Returns the error messages of the step.
Collection<String>	getInfoMessages()	Returns the information messages of the step.
final Run<?,?>	getOwner()	Returns the build as owner of this view model.
boolean	hasErrors()	Returns whether error messages are present.

Methods inherited from class java.lang.Object

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

Constructor Details

MessagesViewModel

public MessagesViewModel(Run<?,?> owner,
 String displayName,
 List<String> infoMessages)

Creates a new MessagesViewModel with info messages only.

Parameters:

owner - current build as owner of this view

displayName - display name of the step

infoMessages - all info messages that should be shown (should not be empty)

MessagesViewModel

public MessagesViewModel(Run<?,?> owner,
 String displayName,
 List<String> infoMessages,
 List<String> errorMessages)

Creates a new MessagesViewModel with error and info messages.

Parameters:

owner - current build as owner of this view

displayName - display name of the step

infoMessages - all info messages that should be shown (should not be empty)

errorMessages - all error messages that should be shown (might be empty)

Method Details

getOwner

public final Run<?,?> getOwner()

Returns the build as owner of this view model.

Returns:

the owner

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getInfoMessages

public Collection<String> getInfoMessages()

Returns the information messages of the step.

Returns:

the information messages

getErrorMessages

public Collection<String> getErrorMessages()

Returns the error messages of the step.

Returns:

the error messages

hasErrors

public boolean hasErrors()

Returns whether error messages are present.

Returns:

true if there are error messages, false if there are only info messages