Record Class LocalDeployPreflight.PreflightOutcome

java.lang.Object

java.lang.Record

com.cloudforgeci.api.deploy.LocalDeployPreflight.PreflightOutcome

Enclosing class:

LocalDeployPreflight

public static record LocalDeployPreflight.PreflightOutcome(PreflightResult result, PreflightMode mode, boolean ran)
extends Record

Constructor Summary

Constructors

Constructor	Description
PreflightOutcome(PreflightResult result, PreflightMode mode)
PreflightOutcome(PreflightResult result, PreflightMode mode, boolean ran)	Creates an instance of a PreflightOutcome record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	formattedWarnings()
final int	hashCode()	Returns a hash code value for this object.
PreflightMode	mode()	Returns the value of the mode record component.
boolean	ran()	Returns the value of the ran record component.
PreflightResult	result()	Returns the value of the result record component.
static LocalDeployPreflight.PreflightOutcome	skipped()
void	throwIfBlocked()
final String	toString()	Returns a string representation of this record class.
List<String>	warningMessages()

Methods inherited from class Object

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

Constructor Details

PreflightOutcome

public PreflightOutcome(PreflightResult result,
 PreflightMode mode)

PreflightOutcome

public PreflightOutcome(PreflightResult result,
 PreflightMode mode,
 boolean ran)

Creates an instance of a PreflightOutcome record class.

Parameters:

result - the value for the result record component

mode - the value for the mode record component

ran - the value for the ran record component

Method Details

skipped

public static LocalDeployPreflight.PreflightOutcome skipped()

warningMessages

public List<String> warningMessages()

throwIfBlocked

public void throwIfBlocked()
                    throws IOException

Throws:

IOException

formattedWarnings

public String formattedWarnings()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

result

public PreflightResult result()

Returns the value of the result record component.

Returns:

the value of the result record component

mode

public PreflightMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

ran

public boolean ran()

Returns the value of the ran record component.

Returns:

the value of the ran record component