View Javadoc

1   /*
2    * Copyright 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.properties.config.transfer.templatestream;
17  
18  import de.smartics.exceptions.i18n.message.MessageParam;
19  import de.smartics.properties.api.config.domain.ConfigurationMessageBean;
20  import de.smartics.properties.spi.config.transfer.TransferMessageBean;
21  
22  /**
23   * Signals the the configured escaper implementation cannot be instantiated.
24   */
25  public class InvalidEscaperTransferMessageBean extends ConfigurationMessageBean
26      implements TransferMessageBean
27  {
28    // ********************************* Fields *********************************
29  
30    // --- constants ------------------------------------------------------------
31  
32    /**
33     * The class version identifier.
34     */
35    private static final long serialVersionUID = 1L;
36  
37    // --- members --------------------------------------------------------------
38  
39    /**
40     * The type of the escaper that caused trouble.
41     *
42     * @serial
43     */
44    @MessageParam
45    private final String escaperType; // NOPMD
46  
47    // ****************************** Initializer *******************************
48  
49    // ****************************** Constructors ******************************
50  
51    /**
52     * Default constructor.
53     *
54     * @param cause the cause to the problem.
55     * @param escaperType the type of the escaper that caused trouble.
56     */
57    public InvalidEscaperTransferMessageBean(final Throwable cause,
58        final String escaperType)
59    {
60      super(TransferStreamCode.INVALID_ESCAPER, cause, null);
61      this.escaperType = escaperType;
62    }
63  
64    // ****************************** Inner Classes *****************************
65  
66    // ********************************* Methods ********************************
67  
68    // --- init -----------------------------------------------------------------
69  
70    // --- factory --------------------------------------------------------------
71  
72    // --- get&set --------------------------------------------------------------
73  
74    // --- business -------------------------------------------------------------
75  
76    // --- object basics --------------------------------------------------------
77  
78  }