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  /**
19   * Provides information to wrap an instance of output.
20   */
21  public final class Wrapper
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    // --- members --------------------------------------------------------------
28  
29    /**
30     * The text to write before the output. May be <code>null</code>.
31     */
32    private String intro;
33  
34    /**
35     * The text to write after the output. May be <code>null</code>.
36     */
37    private String extro;
38  
39    // ****************************** Initializer *******************************
40  
41    // ****************************** Constructors ******************************
42  
43    // ****************************** Inner Classes *****************************
44  
45    // ********************************* Methods ********************************
46  
47    // --- init -----------------------------------------------------------------
48  
49    // --- get&set --------------------------------------------------------------
50  
51    /**
52     * Returns the text to write before the output. May be <code>null</code>.
53     *
54     * @return the text to write before the output.
55     */
56    public String getIntro()
57    {
58      return intro;
59    }
60  
61    /**
62     * Returns the text to write after the output. May be <code>null</code>.
63     *
64     * @return the text to write after the output.
65     */
66    public String getExtro()
67    {
68      return extro;
69    }
70  
71    /**
72     * Sets the text to write before the output. May be <code>null</code>.
73     *
74     * @param intro the text to write before the output. May be <code>null</code>.
75     */
76    public void setIntro(final String intro)
77    {
78      this.intro = intro;
79    }
80  
81    /**
82     * Sets the text to write after the output. May be <code>null</code>.
83     *
84     * @param extro the text to write after the output. May be <code>null</code>.
85     */
86    public void setExtro(final String extro)
87    {
88      this.extro = extro;
89    }
90  
91    // --- business -------------------------------------------------------------
92  
93    // --- object basics --------------------------------------------------------
94  
95  }