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.referencing;
033
034 import org.opengis.util.NoSuchIdentifierException;
035
036
037 /**
038 * Thrown when an {@linkplain AuthorityFactory authority factory} can't find
039 * the requested authority code.
040 *
041 * @departure extension
042 * This exception is not part of the OGC specification.
043 *
044 * @author Martin Desruisseaux (IRD)
045 * @version 3.0
046 * @since 1.0
047 *
048 * @see org.opengis.referencing.crs.CRSAuthorityFactory
049 * @see org.opengis.referencing.cs.CSAuthorityFactory
050 * @see org.opengis.referencing.datum.DatumAuthorityFactory
051 */
052 public class NoSuchAuthorityCodeException extends NoSuchIdentifierException {
053 /**
054 * Serial number for inter-operability with different versions.
055 */
056 private static final long serialVersionUID = -1573748311981746573L;
057
058 /**
059 * The authority.
060 */
061 private final String authority;
062
063 /**
064 * The invalid authority code.
065 */
066 private final String code;
067
068 /**
069 * Constructs an exception with the specified detail message and authority code.
070 *
071 * @param message The detail message. The detail message is saved
072 * for later retrieval by the {@link #getMessage()} method.
073 * @param authority The authority, saved for retrieval by the {@link #getAuthority()} method.
074 * @param code The invalid authority code, saved for retrieval by the {@link #getAuthorityCode()} method.
075 */
076 public NoSuchAuthorityCodeException(String message, String authority, String code) {
077 this(message, authority, code, (authority == null) ? code : (code == null) ? authority : authority + ':' + code);
078 }
079
080 /**
081 * Constructs an exception with the specified detail message, authority code and identifier.
082 * The identifier argument is optional. If omitted, then "{@code authority:code}" will be used.
083 *
084 * @param message The detail message. The detail message is saved
085 * for later retrieval by the {@link #getMessage()} method.
086 * @param authority The authority, saved for retrieval by the {@link #getAuthority()} method.
087 * @param code The invalid authority code, saved for retrieval by the {@link #getAuthorityCode()} method.
088 * @param identifier The full identifier as a concatenation of the authority and the code,
089 * saved for retrieval by the {@link #getIdentifierCode()} method.
090 */
091 public NoSuchAuthorityCodeException(String message, String authority, String code, String identifier) {
092 super(message, identifier);
093 this.authority = authority;
094 this.code = code;
095 }
096
097 /**
098 * Returns the authority.
099 *
100 * @return The authority, or {@code null} if unknown.
101 */
102 public String getAuthority() {
103 return authority;
104 }
105
106 /**
107 * Returns the invalid authority code.
108 *
109 * @return The authority code, or {@code null} if unknown.
110 */
111 public String getAuthorityCode() {
112 return code;
113 }
114 }