/**
* Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright ownership. Apereo
* licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the License at the
* following location:
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>Unless required by applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apereo.portal.properties;
/**
* This is an undeclared (Runtime) exception to be thrown by the PropertiesManager when a property
* is requested but cannot be parsed and returned as the desired type.
*
* @since 2.4
*/
public class BadPropertyException extends RuntimeException {
/** The name of the property */
private final String propertyName;
/** The value of the property */
private final String propertyValue;
/** The desired type, as which the property could not be parsed. */
private final String desiredType;
/**
* Instantiate a new BadPropertyException.
*
* @param propertyName - the name of the property
* @param propertyValue - the bad value of the property.
* @param desiredType - the name of the desired type which the value wasn't, making it bad.
*/
public BadPropertyException(String propertyName, String propertyValue, String desiredType) {
this.propertyName = propertyName;
this.propertyValue = propertyValue;
this.desiredType = desiredType;
}
public String getMessage() {
return "The property ["
+ this.propertyName
+ "] had value ["
+ this.propertyValue
+ "] which could not be parsed as type ["
+ this.desiredType
+ "].";
}
public String getLocalizedMessage() {
return getMessage();
}
/**
* Get the desired type as which the property could not be parsed.
*
* @return Returns the desiredType.
*/
public String getDesiredType() {
return this.desiredType;
}
/**
* Get the name of the bad property.
*
* @return Returns the propertyName.
*/
public String getPropertyName() {
return this.propertyName;
}
/**
* Get the actual value of the property.
*
* @return Returns the propertyValue.
*/
public String getPropertyValue() {
return this.propertyValue;
}
}