fr.cnes.sirius.patrius.math.exception

Class MultiDimensionMismatchException

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.MultiDimensionMismatchException

All Implemented Interfaces:

ExceptionContextProvider, Serializable

Direct Known Subclasses:

MatrixDimensionMismatchException

public class MultiDimensionMismatchException
extends MathIllegalArgumentException

Exception to be thrown when two sets of dimensions differ.

Since:

3.0

Version:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiDimensionMismatchException(Integer[] wrongIn, Integer[] expectedIn) Deprecated. since 4.17, as the default message does not give the user enough context. Use MultiDimensionMismatchException(Localizable, Integer[], Integer[]) instead, with a more explicit message.
MultiDimensionMismatchException(Localizable specific, Integer[] wrongIn, Integer[] expectedIn) Construct an exception from the mismatched dimensions.

Method Summary

Modifier and Type	Method and Description
int	getExpectedDimension(int index) Getter for the expected dimension stored at index.
Integer[]	getExpectedDimensions() Getter for the array containing the expected dimensions.
int	getWrongDimension(int index) Getter for the wrong dimension stored at index.
Integer[]	getWrongDimensions() Getter for the array containing the wrong dimensions.

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

MultiDimensionMismatchException

@Deprecated
public MultiDimensionMismatchException(Integer[] wrongIn,
                                                   Integer[] expectedIn)

Deprecated. since 4.17, as the default message does not give the user enough context. Use MultiDimensionMismatchException(Localizable, Integer[], Integer[]) instead, with a more explicit message.

Construct an exception from the mismatched dimensions.

Parameters:

wrongIn - Wrong dimensions

expectedIn - Expected dimensions

MultiDimensionMismatchException

public MultiDimensionMismatchException(Localizable specific,
                                       Integer[] wrongIn,
                                       Integer[] expectedIn)

Construct an exception from the mismatched dimensions.

Parameters:

specific - Message pattern providing the specific context of the error

wrongIn - Wrong dimensions

expectedIn - Expected dimensions

Method Detail

getWrongDimensions

public Integer[] getWrongDimensions()

Getter for the array containing the wrong dimensions.

Returns:

an array containing the wrong dimensions

getExpectedDimensions

public Integer[] getExpectedDimensions()

Getter for the array containing the expected dimensions.

Returns:

an array containing the expected dimensions

getWrongDimension

public int getWrongDimension(int index)

Getter for the wrong dimension stored at index.

Parameters:

index - Dimension index

Returns:

the wrong dimension stored at index

getExpectedDimension

public int getExpectedDimension(int index)

Getter for the expected dimension stored at index.

Parameters:

index - Dimension index

Returns:

the expected dimension stored at index