minified-utils/com.dervarex.minified.utils.exceptions

StopException

exceptionstableSource

@API(status = STABLE)
public class StopException
    extends RuntimeException

A controlled abort/stop signal with structured details. Throw this when an operation must be terminated intentionally (user cancel, precondition failed, safety stop) rather than due to an unexpected bug.

Superclasses: RuntimeException → Exception → Throwable
Implemented interfaces: Serializable

Methods

StopException fatal(String)String getCode()Map<String, String> getMetadata()String getReason()Severity getSeverity()long getTimestampEpochMillis()Instant getTimestampInstant()boolean isRecoverable()StopException preconditionFailed(String)String toJson()String toUserFriendlyMessage()StopException userCancel(String)

fatal(String)

staticSource

public static StopException fatal(String reason)

Parameters
`reason`	`String`
Returns
`StopException`

getCode()

Source

public String getCode()

Returns
`String`

getMetadata()

Source

public Map<String, String> getMetadata()

Returns
`Map<String, String>`

getReason()

Source

public String getReason()

Returns
`String`

getSeverity()

Source

public Severity getSeverity()

Returns
`Severity`

getTimestampEpochMillis()

Source

public long getTimestampEpochMillis()

Returns
`long`

getTimestampInstant()

Source

public Instant getTimestampInstant()

Returns
`Instant`

isRecoverable()

Source

public boolean isRecoverable()

Returns
`boolean`

preconditionFailed(String)

staticSource

public static StopException preconditionFailed(String reason)

Parameters
`reason`	`String`
Returns
`StopException`

toJson()

Source

public String toJson()

Returns
`String`

toUserFriendlyMessage()

Source

public String toUserFriendlyMessage()

Returns
`String`

userCancel(String)

staticSource

public static StopException userCancel(String reason)

Parameters
`reason`	`String`
Returns
`StopException`

Nested types

StopException.Severityenum

No description.

StopException.Builderclass

No description.

Used by

Methods of other types that accept or return StopException.

StopException.Builder.build()