Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.exception

Class CharSequenceTooLongException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.tquadrat.foundation.exception.ValidationException

org.tquadrat.foundation.exception.CharSequenceTooLongException

All Implemented Interfaces:

Serializable

@ClassVersion(sourceVersion="$Id: CharSequenceTooLongException.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public final class CharSequenceTooLongException
extends ValidationException

This is a specialized implementation for the IllegalArgumentException that should be used instead of the latter in cases where a CharSequence provided as a method argument is too long according to some external constraints, like the column definition of a database.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CharSequenceTooLongException.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.0.5

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.exception.CharSequenceTooLongException"

⁠

Field Summary

Fields inherited from class org.tquadrat.foundation.exception.ValidationException

MSG_ValidationFailed

Constructor Summary

Constructors

Constructor	Description
CharSequenceTooLongException(int maxLength)	Creates a new instance of CharSequenceTooLongException.
CharSequenceTooLongException(String argName, int maxLength)	Creates a new instance of CharSequenceTooLongException.

Method Summary

Modifier and Type	Method	Description
private static int	checkLength(int maxLength)	Checks the given value.

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

CharSequenceTooLongException

public CharSequenceTooLongException(String argName,
 int maxLength)

Creates a new instance of CharSequenceTooLongException.

Parameters:

argName - The name of the argument whose value was too long.

maxLength - The maximum length.

CharSequenceTooLongException

public CharSequenceTooLongException(int maxLength)

Creates a new instance of CharSequenceTooLongException.

Parameters:

maxLength - The maximum length.

Method Details

checkLength

private static int checkLength(int maxLength)
                        throws ValidationException

Checks the given value.

Parameters:

maxLength - The provided legal length for a text.

Returns:

The given value.

Throws:

ValidationException - The given value was less than 1.