Package org.anchoranalysis.feature.calculate

Class NamedFeatureCalculateException

Object

Throwable

Exception

AnchorCheckedException

AnchorFriendlyCheckedException

NamedFeatureCalculateException

All Implemented Interfaces:

Serializable, HasFriendlyErrorMessage

public class NamedFeatureCalculateException
extends AnchorFriendlyCheckedException

An exception that occurs when a feature fails to successfully calculate.

The feature may optionally have a name associated with it, to help identify it to the user.

Author:

Owen Feehan

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NamedFeatureCalculateException(Exception cause)	Creates with a calculation error that doesn't pertain to any particular feature.
NamedFeatureCalculateException(String message)	Creates with a general failure message that doesn't pertain to any particular feature.
NamedFeatureCalculateException(String featureName, String message)	Creates with a failure message associated with a particular feature.

Method Summary

Modifier and Type	Method	Description
FeatureCalculationException	dropKey()	Removes any feature-name from the exception.

Methods inherited from class org.anchoranalysis.core.exception.friendly.AnchorFriendlyCheckedException

friendlyMessage, friendlyMessageHierarchy, friendlyMessageHierarchy, stackTrace

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 Details

NamedFeatureCalculateException

public NamedFeatureCalculateException(String message)

Creates with a general failure message that doesn't pertain to any particular feature.

Parameters:

message - the message.

NamedFeatureCalculateException

public NamedFeatureCalculateException(Exception cause)

Creates with a calculation error that doesn't pertain to any particular feature.

Parameters:

cause - reason for failure.

NamedFeatureCalculateException

public NamedFeatureCalculateException(String featureName,
 String message)

Creates with a failure message associated with a particular feature.

Parameters:

featureName - a name to describe the feature whose calculation failed.

message - the reason for failure.

Method Details

dropKey

public FeatureCalculationException dropKey()

Removes any feature-name from the exception.

Returns:

a newly-created similar exception, but lacking any identifier for which feature caused the exception.