001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math3.exception.util;
018
019/**
020 * Interface for accessing the context data structure stored in Commons Math
021 * exceptions.
022 *
023 * @version $Id: ExceptionContextProvider.java 1364388 2012-07-22 18:16:43Z tn $
024 */
025public interface ExceptionContextProvider {
026    /**
027     * Gets a reference to the "rich context" data structure that allows to
028     * customize error messages and store key, value pairs in exceptions.
029     *
030     * @return a reference to the exception context.
031     */
032    ExceptionContext getContext();
033
034}