View Javadoc
1   /*
2    *   Copyright (C) Christian Schulte <cs@schulte.it>, 2005-206
3    *   All rights reserved.
4    *
5    *   Redistribution and use in source and binary forms, with or without
6    *   modification, are permitted provided that the following conditions
7    *   are met:
8    *
9    *     o Redistributions of source code must retain the above copyright
10   *       notice, this list of conditions and the following disclaimer.
11   *
12   *     o Redistributions in binary form must reproduce the above copyright
13   *       notice, this list of conditions and the following disclaimer in
14   *       the documentation and/or other materials provided with the
15   *       distribution.
16   *
17   *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18   *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19   *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20   *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21   *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   *
28   *   $JOMC: ToolsModletConstants.java 5043 2015-05-27 07:03:39Z schulte $
29   *
30   */
31  package org.jomc.tools.modlet;
32  
33  /**
34   * Object management and configuration tools modlet constants.
35   *
36   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
37   * @version $JOMC: ToolsModletConstants.java 5043 2015-05-27 07:03:39Z schulte $
38   */
39  interface ToolsModletConstants
40  {
41  
42      /**
43       * Constant for the name of the constructors source code section.
44       */
45      String CONSTRUCTORS_SECTION_NAME = "Constructors";
46  
47      /**
48       * Constant for the name of the default constructor source code section.
49       */
50      String DEFAULT_CONSTRUCTOR_SECTION_NAME = "Default Constructor";
51  
52      /**
53       * Constant for the name of the dependencies source code section.
54       */
55      String DEPENDENCIES_SECTION_NAME = "Dependencies";
56  
57      /**
58       * Constant for the name of the properties source code section.
59       */
60      String PROPERTIES_SECTION_NAME = "Properties";
61  
62      /**
63       * Constant for the name of the messages source code section.
64       */
65      String MESSAGES_SECTION_NAME = "Messages";
66  
67      /**
68       * Constant for the name of the license source code section.
69       */
70      String LICENSE_SECTION_NAME = "License Header";
71  
72      /**
73       * Constant for the name of the documentation source code section.
74       */
75      String DOCUMENTATION_SECTION_NAME = "Documentation";
76  
77      /**
78       * Constant for the name of the implementation annotations source code section.
79       */
80      String ANNOTATIONS_SECTION_NAME = "Annotations";
81  
82      /**
83       * Name of the {@code implementation-constructors-head.vm} template.
84       */
85      String CONSTRUCTORS_HEAD_TEMPLATE = "implementation-constructors-head.vm";
86  
87      /**
88       * Name of the {@code implementation-constructors-tail.vm} template.
89       */
90      String CONSTRUCTORS_TAIL_TEMPLATE = "implementation-constructors-tail.vm";
91  
92      /**
93       * Name of the {@code implementation-default-constructor.vm} template.
94       */
95      String DEFAULT_CONSTRUCTOR_TEMPLATE = "implementation-default-constructor.vm";
96  
97      /**
98       * Name of the {@code implementation-dependencies.vm} template.
99       */
100     String DEPENDENCIES_TEMPLATE = "implementation-dependencies.vm";
101 
102     /**
103      * Name of the {@code implementation-properties.vm} template.
104      */
105     String PROPERTIES_TEMPLATE = "implementation-properties.vm";
106 
107     /**
108      * Name of the {@code implementation-messages.vm} template.
109      */
110     String MESSAGES_TEMPLATE = "implementation-messages.vm";
111 
112     /**
113      * Name of the {@code specification-license.vm} template.
114      */
115     String SPECIFICATION_LICENSE_TEMPLATE = "specification-license.vm";
116 
117     /**
118      * Name of the {@code implementation-license.vm} template.
119      */
120     String IMPLEMENTATION_LICENSE_TEMPLATE = "implementation-license.vm";
121 
122     /**
123      * Name of the {@code specification-documentation.vm} template.
124      */
125     String SPECIFICATION_DOCUMENTATION_TEMPLATE = "specification-documentation.vm";
126 
127     /**
128      * Name of the {@code implementation-documentation.vm} template.
129      */
130     String IMPLEMENTATION_DOCUMENTATION_TEMPLATE = "implementation-documentation.vm";
131 
132     /**
133      * Name of the {@code Implementation.java.vm} template.
134      */
135     String IMPLEMENTATION_TEMPLATE = "Implementation.java.vm";
136 
137     /**
138      * Name of the {@code Specification.java.vm} template.
139      */
140     String SPECIFICATION_TEMPLATE = "Specification.java.vm";
141 
142     /**
143      * Name of the {@code specification-annotations.vm} template.
144      */
145     String SPECIFICATION_ANNOTATIONS_TEMPLATE = "specification-annotations.vm";
146 
147     /**
148      * Name of the {@code implementation-annotations.vm} template.
149      */
150     String IMPLEMENTATION_ANNOTATIONS_TEMPLATE = "implementation-annotations.vm";
151 
152 }