fr.cnes.sirius.patrius.math.exception

Class DimensionMismatchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

fr.cnes.sirius.patrius.math.exception.MathIllegalArgumentException

fr.cnes.sirius.patrius.math.exception.MathIllegalNumberException

fr.cnes.sirius.patrius.math.exception.DimensionMismatchException

All Implemented Interfaces:

ExceptionContextProvider, Serializable

Direct Known Subclasses:

NonSquareMatrixException, NonSquareOperatorException

public class DimensionMismatchException
extends MathIllegalNumberException

Exception to be thrown when two dimensions differ.

Since:

2.2

Version:

$Id: DimensionMismatchException.java 18108 2017-10-04 06:45:27Z bignon $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DimensionMismatchException(int wrong, int expected) Deprecated. since 4.14, as the default message does not give the user enough context. Use DimensionMismatchException(Localizable, int, int) instead, with a more explicit message.
DimensionMismatchException(Localizable specific, int wrong, int expected) Construct an exception from the mismatched dimensions.
DimensionMismatchException(Localizable pattern, String wrongName, int wrong, String expectedName, int expected) Construct an exception from the mismatched dimensions.
DimensionMismatchException(String specific, int wrong, int expected) Construct an exception from the mismatched dimensions.

Method Summary

Modifier and Type	Method and Description
int	getDimension() Getter for the expected dimension.

Methods inherited from class fr.cnes.sirius.patrius.math.exception.MathIllegalNumberException

getArgument

Methods inherited from class fr.cnes.sirius.patrius.math.exception.MathIllegalArgumentException

getContext, getLocalizedMessage, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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

DimensionMismatchException

public DimensionMismatchException(Localizable specific,
                                  int wrong,
                                  int expected)

Construct an exception from the mismatched dimensions.

Parameters:

specific - Specific context information pattern

wrong - Wrong dimension

expected - Expected dimension

DimensionMismatchException

public DimensionMismatchException(String specific,
                                  int wrong,
                                  int expected)

Construct an exception from the mismatched dimensions.
Placeholders can be used in the string to include the "wrong" and "expected" values, using "{0}" and "{1}" respectively.

Parameters:

specific - Specific context information string

wrong - Wrong dimension

expected - Expected dimension

DimensionMismatchException

public DimensionMismatchException(Localizable pattern,
                                  String wrongName,
                                  int wrong,
                                  String expectedName,
                                  int expected)

Construct an exception from the mismatched dimensions.
Placeholders can be used in the string to include the "wrong" and "expected" names and values :

wrong value name : "{0}" wrong value : "{1}" expected value name : "{2}" expected value : "{3}"

Parameters:

pattern - Specific context information string

wrongName - Wrong dimension name

wrong - Wrong dimension

expectedName - Expected dimension name

expected - Expected dimension

DimensionMismatchException

@Deprecated
public DimensionMismatchException(int wrong,
                                              int expected)

Deprecated. since 4.14, as the default message does not give the user enough context. Use DimensionMismatchException(Localizable, int, int) instead, with a more explicit message.

Construct an exception from the mismatched dimensions

Parameters:

wrong - Wrong dimension

expected - Expected dimension

Method Detail

getDimension

public int getDimension()

Getter for the expected dimension.

Returns:

the expected dimension