Package org.jenkinsci.plugins.github.extension.status.misc

Class ConditionalResult

java.lang.Object

hudson.model.AbstractDescribableImpl<ConditionalResult>

org.jenkinsci.plugins.github.extension.status.misc.ConditionalResult

All Implemented Interfaces:

ExtensionPoint, Describable<ConditionalResult>

Direct Known Subclasses:

AnyBuildResult, BetterThanOrEqualBuildResult

public abstract class ConditionalResult
extends AbstractDescribableImpl<ConditionalResult>
implements ExtensionPoint

This extension point allows to define when and what to send as state and message. It will be used as part of ConditionalStatusResultSource.

Since:

1.19.0

Author:

lanwen (Merkushev Kirill)

See Also:

BetterThanOrEqualBuildResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConditionalResult.ConditionalResultDescriptor	Should be extended to and marked as Extension to be in list

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ConditionalResult()

Method Summary

Modifier and Type	Method	Description
String	getMessage()
String	getState()
abstract boolean	matches(Run<?,?> run)	If matches, will be used to set state
void	setMessage(String message)
void	setState(String state)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionalResult

public ConditionalResult()

Method Detail

setState

@DataBoundSetter
public void setState(String state)

setMessage

@DataBoundSetter
public void setMessage(String message)

getState

public String getState()

Returns:

State to set. Will be converted to GHCommitState

getMessage

public String getMessage()

Returns:

Message to write. Can contain env vars, will be expanded.

matches

public abstract boolean matches(@NonNull
                                Run<?,?> run)

If matches, will be used to set state

Parameters:

run - to check against

Returns:

true if matches