org.opengis.parameter
Class InvalidParameterCardinalityException

Show UML class diagram

Object
  Throwable
      Exception
          RuntimeException
              IllegalStateException
                  InvalidParameterCardinalityException

All Implemented Interfaces:

Serializable

public class InvalidParameterCardinalityException
extends IllegalStateException

Thrown by ParameterValueGroup if adding or removing a parameter value would result in more or less parameters than the expected range. The [minimum … maximum] range is defined by the ParameterDescriptorGroup instance associated with the ParameterValueGroup.

This exception may be thrown directly by the ParameterValueGroup.addGroup(String) method, or indirectly during the add or remove operations on the list returned by ParameterValueGroup.values().

Note: This exception is of kind IllegalStateException instead than IllegalArgumentException because it is not caused by a bad argument. It is rather a consequence of an ParameterValueGroup being "full".

Since:

2.0

See Also:

ParameterValueGroup.values(), ParameterValueGroup.addGroup(String), Serialized Form

Departure from OGC/ISO specification:
This exception is not part of the OGC specification.

Constructor Summary

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

InvalidParameterCardinalityException(String message, Throwable cause, String parameterName)
Creates an exception with the specified message, cause and parameter name.

Method Summary

String

getParameterName() Returns the name of the parameter with invalid cardinality.

Methods inherited from class Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidParameterCardinalityException

public InvalidParameterCardinalityException(String message,
                                            String parameterName)

Creates an exception with the specified message and parameter name.

Parameters:

message - The detail message, or null if none. The detail message is saved for later retrieval by the Throwable.getMessage() method.

parameterName - The name of the parameter with invalid cardinality.

InvalidParameterCardinalityException

public InvalidParameterCardinalityException(String message,
                                            Throwable cause,
                                            String parameterName)

Creates an exception with the specified message, cause and parameter name.

Parameters:

message - The detail message, or null if none. The detail message is saved for later retrieval by the Throwable.getMessage() method.

cause - The cause, or null if none. The cause is saved for later retrieval by the Throwable.getCause() method.

parameterName - The name of the parameter with invalid cardinality.

Since:

3.1

Method Detail

getParameterName

public String getParameterName()

Returns the name of the parameter with invalid cardinality.

Returns:

The name of the parameter with invalid cardinality.