View Javadoc

1   /*
2    * Copyright 2007-2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.exceptions.core;
17  
18  /**
19   * Defines access to the resources required by the exception infrastructure.
20   */
21  public interface ExceptionContext
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    // ****************************** Inner Classes *****************************
28  
29    // ********************************* Methods ********************************
30  
31    // --- get&set --------------------------------------------------------------
32  
33    // --- business -------------------------------------------------------------
34  
35    /**
36     * Returns the configuration to control the handling of throwables.
37     *
38     * @return the configured mode.
39     */
40    ThrowableHandleMode getThrowableHandleMode();
41  
42    /**
43     * Returns the factory for generating identifiers.
44     *
45     * @return the factory for generating identifiers.
46     */
47    IdFactory getIdFactory();
48  
49    /**
50     * Returns the formatter for code messages. Override to control the
51     * representation of exception and message bean instances.
52     *
53     * @return the formatter for code messages.
54     */
55    CodeMessageFormatter getCodeMessageFormatter();
56  
57    // --- object basics --------------------------------------------------------
58  }