de.ipcon.tools

Class MissingArgumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

de.ipcon.tools.MissingArgumentException

All Implemented Interfaces:

java.io.Serializable

public class MissingArgumentException
extends java.lang.IllegalArgumentException

Thrown when execution cannot be completed due to a missing attribute or argument (the value may be mandatory only in this specific context, not in general).

Provides localized error messages for standard validation scenarios.

See Also:

MandatoryValueMissingException, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MissingArgumentException.ArgumentCheck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	L10N_KEY_COLLECTION
static java.lang.String	L10N_KEY_COLLECTION_REQUIRES_ONE_VALUE
static java.lang.String	L10N_KEY_LIST_OF_PAIRS
static java.lang.String	L10N_KEY_OBJECT_COLLECTION
static java.lang.String	L10N_KEY_SINGLE_ARGUMENT
static java.lang.String	L10N_KEY_SINGLE_OBJECT

Constructor Summary

Constructors

Constructor and Description
MissingArgumentException(java.util.Collection<MissingValuePair> missingValuePairs) Prints a detailed message combining explicit attribute-to-object pairs.
MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames, java.util.Collection<?> dependingObjects) Prints a message indicating missing attributes across a collection of affected objects.
MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames, java.util.Collection<?> dependingObjects, java.lang.String additionalText) Prints a message indicating missing attributes across a collection of affected objects, with additional text.
MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames, MissingArgumentException.ArgumentCheck argCheck) Prints a message explaining that at least one of the listed arguments must have a value.
MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames, MissingArgumentException.ArgumentCheck argCheck, java.lang.String additionalText) Prints a message explaining that at least one of the listed arguments must have a value, with additional text.
MissingArgumentException(java.lang.String missingArgumentName) Prints the simplest exception message stating that a required value of the given name was not set.
MissingArgumentException(java.lang.String missingArgumentName, java.lang.Object dependingObject) Prints a message specifically for a single attribute missing on a single object.
MissingArgumentException(java.lang.String missingArgumentName, java.lang.Object dependingObject, java.lang.String additionalText) Prints a message specifically for a single attribute missing on a single object, with additional text.
MissingArgumentException(java.lang.Throwable cause) Constructs an exception with an underlying cause without generating a specialized error message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalText()
java.util.Collection<java.lang.Object>	getDependingObjects()
java.util.Collection<java.lang.String>	getMissingArgumentNames()

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

L10N_KEY_SINGLE_ARGUMENT

public static final java.lang.String L10N_KEY_SINGLE_ARGUMENT

See Also:

Constant Field Values

L10N_KEY_COLLECTION_REQUIRES_ONE_VALUE

public static final java.lang.String L10N_KEY_COLLECTION_REQUIRES_ONE_VALUE

See Also:

Constant Field Values

L10N_KEY_COLLECTION

public static final java.lang.String L10N_KEY_COLLECTION

See Also:

Constant Field Values

L10N_KEY_SINGLE_OBJECT

public static final java.lang.String L10N_KEY_SINGLE_OBJECT

See Also:

Constant Field Values

L10N_KEY_OBJECT_COLLECTION

public static final java.lang.String L10N_KEY_OBJECT_COLLECTION

See Also:

Constant Field Values

L10N_KEY_LIST_OF_PAIRS

public static final java.lang.String L10N_KEY_LIST_OF_PAIRS

See Also:

Constant Field Values

Constructor Detail

MissingArgumentException

public MissingArgumentException(java.lang.Throwable cause)

Constructs an exception with an underlying cause without generating a specialized error message.

Parameters:

cause - the underlying exception

MissingArgumentException

public MissingArgumentException(java.lang.String missingArgumentName)

Prints the simplest exception message stating that a required value of the given name was not set.

Parameters:

missingArgumentName - name of the required argument or parameter

MissingArgumentException

public MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames,
                                MissingArgumentException.ArgumentCheck argCheck)

Prints a message explaining that at least one of the listed arguments must have a value.

Parameters:

missingArgumentNames - names of the missing attributes

argCheck - mode selector (any value vs each value)

MissingArgumentException

public MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames,
                                MissingArgumentException.ArgumentCheck argCheck,
                                java.lang.String additionalText)

Prints a message explaining that at least one of the listed arguments must have a value, with additional text.

Parameters:

missingArgumentNames - names of the missing attributes

argCheck - mode selector (any value vs each value)

additionalText - optional explanatory text appended to the message (must be pre-translated if localization is required)

MissingArgumentException

public MissingArgumentException(java.lang.String missingArgumentName,
                                java.lang.Object dependingObject)

Prints a message specifically for a single attribute missing on a single object.

Parameters:

missingArgumentName - name of the required attribute

dependingObject - the object requiring the attribute

MissingArgumentException

public MissingArgumentException(java.lang.String missingArgumentName,
                                java.lang.Object dependingObject,
                                java.lang.String additionalText)

Prints a message specifically for a single attribute missing on a single object, with additional text.

Parameters:

missingArgumentName - name of the required attribute

dependingObject - the object requiring the attribute

additionalText - optional explanatory text appended to the message (must be pre-translated if localization is required)

MissingArgumentException

public MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames,
                                java.util.Collection<?> dependingObjects)

Prints a message indicating missing attributes across a collection of affected objects.

To pinpoint the exact location and pairing of missing values within an object graph, use NullCheckTools to inspect the collection and obtain detailed diagnostics.

Parameters:

missingArgumentNames - names of the missing attributes

dependingObjects - collection of affected objects

MissingArgumentException

public MissingArgumentException(java.util.Collection<java.lang.String> missingArgumentNames,
                                java.util.Collection<?> dependingObjects,
                                java.lang.String additionalText)

Prints a message indicating missing attributes across a collection of affected objects, with additional text.

To pinpoint the exact location and pairing of missing values within an object graph, use NullCheckTools to inspect the collection and obtain detailed diagnostics.

Parameters:

missingArgumentNames - names of the missing attributes

dependingObjects - collection of affected objects

additionalText - optional explanatory text appended to the message (must be pre-translated if localization is required)

MissingArgumentException

public MissingArgumentException(java.util.Collection<MissingValuePair> missingValuePairs)

Prints a detailed message combining explicit attribute-to-object pairs.

Unlike the collection-based constructors, each MissingValuePair binds a specific missing attribute directly to its enclosing object, formatting a structured trace in the error output.

Parameters:

missingValuePairs - collection of attribute-object pairings

Method Detail

getMissingArgumentNames

public java.util.Collection<java.lang.String> getMissingArgumentNames()

getDependingObjects

public java.util.Collection<java.lang.Object> getDependingObjects()

getAdditionalText

public java.lang.String getAdditionalText()