001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.util;
033
034 import org.opengis.metadata.Identifier;
035 import org.opengis.parameter.ParameterValueGroup; // For javadoc
036
037
038 /**
039 * Thrown when an identifier provided to a factory method can not be found.
040 * The identifier is often provided by {@link Identifier#getCode()}.
041 * <p>
042 * <b>Example:</b> This exception is thrown when a
043 * {@linkplain org.opengis.referencing.operation.MathTransform math transform}
044 * as been requested with an unknown {@linkplain org.opengis.referencing.operation.OperationMethod
045 * operation method} identifier.
046 *
047 * @departure extension
048 * This exception is not part of the OGC specification.
049 *
050 * @author Martin Desruisseaux (IRD)
051 * @version 3.0
052 * @since 1.0
053 *
054 * @see org.opengis.referencing.operation.MathTransformFactory#createParameterizedTransform(ParameterValueGroup)
055 */
056 public class NoSuchIdentifierException extends FactoryException {
057 /**
058 * Serial number for inter-operability with different versions.
059 */
060 private static final long serialVersionUID = -6846799994429345902L;
061
062 /**
063 * The identifier code.
064 */
065 private final String identifier;
066
067 /**
068 * Constructs an exception with the specified detail message and classification name.
069 *
070 * @param message The detail message. The detail message is saved
071 * for later retrieval by the {@link #getMessage()} method.
072 * @param identifier The {@linkplain Identifier#getCode() identifier code}.
073 */
074 public NoSuchIdentifierException(final String message, final String identifier) {
075 super(message);
076 this.identifier = identifier;
077 }
078
079 /**
080 * Returns the {@linkplain Identifier#getCode identifier code}.
081 *
082 * @return The identifier code.
083 */
084 public String getIdentifierCode() {
085 return identifier;
086 }
087 }