org.opengis.parameter.InvalidParameterCardinalityException Maven / Gradle / Ivy
Show all versions of geoapi Show documentation
/*
* GeoAPI - Java interfaces for OGC/ISO standards
* http://www.geoapi.org
*
* Copyright (C) 2004-2011 Open Geospatial Consortium, Inc.
* All Rights Reserved. http://www.opengeospatial.org/ogc/legal
*
* Permission to use, copy, and modify this software and its documentation, with
* or without modification, for any purpose and without fee or royalty is hereby
* granted, provided that you include the following on ALL copies of the software
* and documentation or portions thereof, including modifications, that you make:
*
* 1. The full text of this NOTICE in a location viewable to users of the
* redistributed or derivative work.
* 2. Notice of any changes or modifications to the OGC files, including the
* date changes were made.
*
* THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
* NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
* THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
*
* COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
* CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
*
* The name and trademarks of copyright holders may NOT be used in advertising or
* publicity pertaining to the software without specific, written prior permission.
* Title to copyright in this software and any associated documentation will at all
* times remain with copyright holders.
*/
package org.opengis.parameter;
import java.util.List;
/**
* Thrown by {@link ParameterValueGroup} if adding or removing a {@linkplain ParameterValue
* parameter value} would result in more or less parameters than the expected range. The
* [{@linkplain ParameterDescriptor#getMinimumOccurs minimum} …
* {@linkplain ParameterDescriptor#getMaximumOccurs maximum}] range is defined by
* the {@link ParameterDescriptorGroup} instance associated with the {@code ParameterValueGroup}.
*
* This exception may be thrown directly by the {@link ParameterValueGroup#addGroup(String)}
* method, or indirectly during the {@linkplain List#add add} or {@linkplain List#remove remove}
* operations on the list returned by {@link 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".}
*
* @departure extension
* This exception is not part of the OGC specification.
*
* @author Martin Desruisseaux (IRD)
* @version 3.0
* @since 2.0
*
* @see ParameterValueGroup#values()
* @see ParameterValueGroup#addGroup(String)
*/
public class InvalidParameterCardinalityException extends IllegalStateException {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 4030549323541812311L;
/**
* The name of the parameter with invalid cardinality.
*/
private final String parameterName;
/**
* Creates an exception with the specified message and parameter name.
*
* @param message The detail message. The detail message is saved for
* later retrieval by the {@link #getMessage()} method.
* @param parameterName The name of the parameter with invalid cardinality.
*/
public InvalidParameterCardinalityException(String message, String parameterName) {
super(message);
this.parameterName = parameterName;
}
/**
* Returns the name of the parameter with invalid cardinality.
*
* @return The name of the parameter with invalid cardinality.
*/
public String getParameterName() {
return parameterName;
}
}