agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2024r2.jar)

Class StoppedOnMaximumDurationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

agi.foundation.segmentpropagation.StoppedOnMaximumDurationException

All Implemented Interfaces:

Serializable

public class StoppedOnMaximumDurationException
extends RuntimeException

The RuntimeException that gets thrown when a PropagateSegmentResults was stopped on its MaximumDuration (get / set) and if the segment was set to throw if the Duration was exceeded.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StoppedOnMaximumDurationException() Initializes a new instance with a default message.
StoppedOnMaximumDurationException(SegmentListResults cumulativeResults, SegmentDefinition segmentIdentifier, PropagateSegmentResults resultsOfStoppedSegment) Initializes a new instance.
StoppedOnMaximumDurationException(String message) Initializes a new instance with a specified message.
StoppedOnMaximumDurationException(String message, RuntimeException inner) Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.

Method Summary

Modifier and Type	Method and Description
SegmentListResults	getCumulativeResults() Gets the results of the entire propagation, if available, up to and including the SegmentPropagator that stopped propagation.
PropagateSegmentResults	getResultsOfStoppedSegment() Gets the SegmentResults of the SegmentPropagator that stopped propagation.
SegmentDefinition	getSegmentIdentifier() Gets the identifier of the SegmentPropagator that stopped on a maximum Duration, if available.
String	getSegmentName() Gets the name of the SegmentPropagator that threw this exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StoppedOnMaximumDurationException

public StoppedOnMaximumDurationException()

Initializes a new instance with a default message.

StoppedOnMaximumDurationException

public StoppedOnMaximumDurationException(String message)

Initializes a new instance with a specified message.

Parameters:

message - The error message that explains the reason for the exception.

StoppedOnMaximumDurationException

public StoppedOnMaximumDurationException(String message,
                                         RuntimeException inner)

Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters:

message - The error message that explains the reason for the exception.

inner - The exception that is the cause of the current exception.

StoppedOnMaximumDurationException

public StoppedOnMaximumDurationException(SegmentListResults cumulativeResults,
                                         SegmentDefinition segmentIdentifier,
                                         @Nonnull
                                         PropagateSegmentResults resultsOfStoppedSegment)

Initializes a new instance.

Parameters:

cumulativeResults - The results of the entire propagation up to and including the SegmentPropagator that stopped propagation.

resultsOfStoppedSegment - The SegmentResults of the SegmentPropagator that stopped propagation.

segmentIdentifier - The SegmentDefinition of the SegmentPropagator that stopped on a maximum Duration.

Method Detail

getResultsOfStoppedSegment

public final PropagateSegmentResults getResultsOfStoppedSegment()

Gets the SegmentResults of the SegmentPropagator that stopped propagation.

getCumulativeResults

public final SegmentListResults getCumulativeResults()

Gets the results of the entire propagation, if available, up to and including the SegmentPropagator that stopped propagation.

getSegmentName

public final String getSegmentName()

Gets the name of the SegmentPropagator that threw this exception.

getSegmentIdentifier

public final SegmentDefinition getSegmentIdentifier()

Gets the identifier of the SegmentPropagator that stopped on a maximum Duration, if available.