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.report.renderer;
17  
18  import com.thoughtworks.qdox.model.DocletTag;
19  
20  /**
21   * Renders version tags.
22   */
23  public interface VersionTagRenderer
24  {
25  
26    // ********************************* Fields *********************************
27  
28    // --- constants ------------------------------------------------------------
29  
30    // ****************************** Initializer *******************************
31  
32    // ****************************** Inner Classes *****************************
33  
34    // ********************************* Methods ********************************
35  
36    // --- get&set --------------------------------------------------------------
37  
38    // --- business -------------------------------------------------------------
39  
40    /**
41     * Renders the version tag.
42     *
43     * @param buffer the buffer to append to.
44     * @param tag the tag to render.
45     * @return the given <code>buffer</code> for convenience.
46     */
47    StringBuilder render(StringBuilder buffer, DocletTag tag);
48  
49    // --- object basics --------------------------------------------------------
50  
51  }