org.opengis.parameter

Class InvalidParameterCardinalityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalStateException

org.opengis.parameter.InvalidParameterCardinalityException

All Implemented Interfaces:

java.io.Serializable

public class InvalidParameterCardinalityException
extends java.lang.IllegalStateException

Throws if adding a parameter value to a group would result in more parameters than the maximum occurence allowed. This operation may be throws during List.add(E) or List.remove(java.lang.Object) operation on the list returned by ParameterValueGroup.values().

Note: This exception is of kind "illegal state" rather than "illegal argument" because it is not caused by a bad argument; it is rather a consequence of an parameter value group being "full".

Since:

GeoAPI 2.0

See Also:

ParameterValueGroup.values(), GeneralParameterDescriptor.getMinimumOccurs(), GeneralParameterDescriptor.getMaximumOccurs(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidParameterCardinalityException(java.lang.String message, java.lang.String parameterName) Creates an exception with the specified message and parameter name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameterName() Returns the name of the parameter with invalid cardinality.

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

Constructor Detail

InvalidParameterCardinalityException

public InvalidParameterCardinalityException(java.lang.String message,
                                            java.lang.String parameterName)

Creates an exception with the specified message and parameter name.

Parameters:

message - The detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

parameterName - The name of the parameter with invalid cardinality.

Method Detail

getParameterName

public java.lang.String getParameterName()

Returns the name of the parameter with invalid cardinality.