Class BuildException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.jdrupes.builder.api.BuildException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConfigurationException, UnavailableException

public class BuildException
extends RuntimeException

Represents an exception that occurs during the build. Terminates the current build when thrown.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BuildException.Reason	The reason the build failed.

Constructor Summary

Constructors

Modifier	Constructor	Description
	BuildException()	Initializes a new build exception with its reason set to BuildException.Reason.Error.
protected	BuildException(BuildException.Reason reason)	Initializes a new build exception with the given reason.

Method Summary

Modifier and Type	Method	Description
BuildException	cause(Throwable cause)	Sets the cause.
BuildException	detail(String detail)	Add information to the details.
String	details()	Return the collected details.
BuildException	from(ResourceProvider resourceProvider)	From.
String	getMessage()
BuildException	message(String format, Object... args)	Sets the message of the build exception.
Optional<ResourceProvider>	origin()	Returns the origin of this exception.
BuildException.Reason	reason()	Returns the reason why the build failed.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Constructor Details

BuildException

public BuildException()

Initializes a new build exception with its reason set to BuildException.Reason.Error.

BuildException

protected BuildException(BuildException.Reason reason)

Initializes a new build exception with the given reason.

Parameters:

reason - the reason

Method Details

reason

public BuildException.Reason reason()

Returns the reason why the build failed.

Returns:

the reason

message

public BuildException message(String format,
 Object... args)

Sets the message of the build exception. As a convenience, any Throwable arguments will be replaced by their message.

Parameters:

format - the format

args - the args

Returns:

the build exception

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

cause

public BuildException cause(Throwable cause)

Sets the cause.

Parameters:

cause - the cause

Returns:

the builds the exception

from

public BuildException from(ResourceProvider resourceProvider)

From.

Parameters:

resourceProvider - the resource provider

Returns:

the builds the exception

detail

public BuildException detail(String detail)

Add information to the details.

Parameters:

detail - the detail

Returns:

the exception

origin

public Optional<ResourceProvider> origin()

Returns the origin of this exception. This is the resource provider set with from(ResourceProvider).

Returns:

the resource provider

details

public String details()

Return the collected details.

Returns:

the string