001// Copyright 2010 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.commons.util;
016
017import org.apache.tapestry5.commons.internal.util.TapestryException;
018
019/**
020 * Special exception used when a value (typically from a map) is referenced that does not exist. Uses a
021 * {@link AvailableValues} object
022 * to track what the known values are.
023 * 
024 * @since 5.2.0
025 */
026public class UnknownValueException extends TapestryException
027{
028    private final AvailableValues availableValues;
029
030    public UnknownValueException(String message, AvailableValues availableValues)
031    {
032        this(message, null, null, availableValues);
033    }
034
035    public UnknownValueException(String message, Object location, Throwable cause, AvailableValues availableValues)
036    {
037        super(message, location, cause);
038
039        this.availableValues = availableValues;
040    }
041
042    public AvailableValues getAvailableValues()
043    {
044        return availableValues;
045    }
046
047}