001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 028 package org.opends.server.admin; 029 030 031 032 import static org.opends.messages.AdminMessages.*; 033 034 import org.opends.messages.Message; 035 036 037 038 /** 039 * Thrown to indicate that a property value was invalid according to 040 * its associated property definition. 041 */ 042 public class IllegalPropertyValueException extends PropertyException { 043 044 /** 045 * Serialization ID. 046 */ 047 private static final long serialVersionUID = -3145632074909281823L; 048 049 // The illegal property value. 050 private final Object value; 051 052 053 054 /** 055 * Create a new illegal property value exception. 056 * 057 * @param pd 058 * The property definition. 059 * @param value 060 * The illegal property value. 061 */ 062 public IllegalPropertyValueException(PropertyDefinition<?> pd, Object value) { 063 super(pd, createMessage(pd, value)); 064 this.value = value; 065 } 066 067 068 069 /** 070 * Get the illegal property value that caused the exception. 071 * 072 * @return Returns the illegal property value. 073 */ 074 public final Object getIllegalValue() { 075 return value; 076 } 077 078 079 080 // Create the message. 081 private static Message createMessage(PropertyDefinition<?> pd, Object value) { 082 PropertyDefinitionUsageBuilder builder = new PropertyDefinitionUsageBuilder( 083 true); 084 return ERR_ILLEGAL_PROPERTY_VALUE_EXCEPTION.get(String.valueOf(value), pd 085 .getName(), builder.getUsage(pd)); 086 } 087 088 }