001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2008-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.feature;
033
034 import org.opengis.feature.type.AttributeDescriptor;
035
036 /**
037 * Indicates a validation check has failed; the provided descriptor and value are available via this
038 * exception.
039 *
040 * @author Jody Garnett (Refractions Research, Inc.)
041 * @since GeoAPI 2.2
042 */
043 public class IllegalAttributeException extends IllegalArgumentException {
044 private static final long serialVersionUID = 3373066465585246605L;
045
046 /**
047 * AttributeDescriptor being used to validate against.
048 */
049 final private AttributeDescriptor descriptor;
050
051 /**
052 * Object that failed validation.
053 */
054 final private Object value;
055
056 public IllegalAttributeException(AttributeDescriptor descriptor, Object value) {
057 super();
058 this.descriptor = descriptor;
059 this.value = value;
060 }
061
062 public IllegalAttributeException(AttributeDescriptor descriptor, Object value, String message) {
063 super(message);
064 this.descriptor = descriptor;
065 this.value = value;
066 }
067
068 public IllegalAttributeException(AttributeDescriptor descriptor, Object value, String message,
069 Throwable t) {
070 super(message, t);
071 this.descriptor = descriptor;
072 this.value = value;
073 }
074
075 public IllegalAttributeException(AttributeDescriptor descriptor, Object value, Throwable t) {
076 super(t);
077 this.descriptor = descriptor;
078 this.value = value;
079 }
080
081 /**
082 * AttribtueDescriptor being checked against.
083 *
084 * @return AttributeDescriptor being checked.
085 */
086 public AttributeDescriptor getDescriptor() {
087 return descriptor;
088 }
089
090 /**
091 * Attribute value that failed validation.
092 *
093 * @return Attribute value
094 */
095 public Object getValue() {
096 return value;
097 }
098
099 @Override
100 public String toString() {
101 String s = getClass().getCanonicalName();
102 String message = getLocalizedMessage();
103
104 StringBuffer buf = new StringBuffer();
105 buf.append(s);
106 if( message != null){
107 buf.append(":");
108 buf.append(message);
109 }
110 if( descriptor != null ){
111 buf.append(":");
112 buf.append( descriptor.getName() );
113 }
114 buf.append(" value:");
115 buf.append( value );
116
117 return buf.toString();
118 }
119 }