1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.math4.legacy.exception.util;
18
19 /**
20 * Interface for accessing the context data structure stored in Commons Math
21 * exceptions.
22 *
23 */
24 public interface ExceptionContextProvider {
25 /**
26 * Gets a reference to the "rich context" data structure that allows to
27 * customize error messages and store key, value pairs in exceptions.
28 *
29 * @return a reference to the exception context.
30 */
31 ExceptionContext getContext();
32 }