View Javadoc

1   /*
2    *   Copyright (C) Christian Schulte, 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 3838 2011-10-08 20:15:41Z schulte2005 $
29   *
30   */
31  package org.jomc.tools.modlet;
32  
33  /**
34   * Object management and configuration tools modlet constants.
35   *
36   * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a>
37   * @version $JOMC: ToolsModletConstants.java 3838 2011-10-08 20:15:41Z schulte2005 $
38   */
39  interface ToolsModletConstants
40  {
41  
42      /** Constant for the name of the constructors source code section. */
43      String CONSTRUCTORS_SECTION_NAME = "Constructors";
44  
45      /** Constant for the name of the default constructor source code section. */
46      String DEFAULT_CONSTRUCTOR_SECTION_NAME = "Default Constructor";
47  
48      /** Constant for the name of the dependencies source code section. */
49      String DEPENDENCIES_SECTION_NAME = "Dependencies";
50  
51      /** Constant for the name of the properties source code section. */
52      String PROPERTIES_SECTION_NAME = "Properties";
53  
54      /** Constant for the name of the messages source code section. */
55      String MESSAGES_SECTION_NAME = "Messages";
56  
57      /** Constant for the name of the license source code section. */
58      String LICENSE_SECTION_NAME = "License Header";
59  
60      /** Constant for the name of the documentation source code section. */
61      String DOCUMENTATION_SECTION_NAME = "Documentation";
62  
63      /** Constant for the name of the implementation annotations source code section. */
64      String ANNOTATIONS_SECTION_NAME = "Annotations";
65  
66      /** Name of the {@code implementation-constructors-head.vm} template. */
67      String CONSTRUCTORS_HEAD_TEMPLATE = "implementation-constructors-head.vm";
68  
69      /** Name of the {@code implementation-constructors-tail.vm} template. */
70      String CONSTRUCTORS_TAIL_TEMPLATE = "implementation-constructors-tail.vm";
71  
72      /** Name of the {@code implementation-default-constructor.vm} template. */
73      String DEFAULT_CONSTRUCTOR_TEMPLATE = "implementation-default-constructor.vm";
74  
75      /** Name of the {@code implementation-dependencies.vm} template. */
76      String DEPENDENCIES_TEMPLATE = "implementation-dependencies.vm";
77  
78      /** Name of the {@code implementation-properties.vm} template. */
79      String PROPERTIES_TEMPLATE = "implementation-properties.vm";
80  
81      /** Name of the {@code implementation-messages.vm} template. */
82      String MESSAGES_TEMPLATE = "implementation-messages.vm";
83  
84      /** Name of the {@code specification-license.vm} template. */
85      String SPECIFICATION_LICENSE_TEMPLATE = "specification-license.vm";
86  
87      /** Name of the {@code implementation-license.vm} template. */
88      String IMPLEMENTATION_LICENSE_TEMPLATE = "implementation-license.vm";
89  
90      /** Name of the {@code specification-documentation.vm} template. */
91      String SPECIFICATION_DOCUMENTATION_TEMPLATE = "specification-documentation.vm";
92  
93      /** Name of the {@code implementation-documentation.vm} template. */
94      String IMPLEMENTATION_DOCUMENTATION_TEMPLATE = "implementation-documentation.vm";
95  
96      /** Name of the {@code Implementation.java.vm} template. */
97      String IMPLEMENTATION_TEMPLATE = "Implementation.java.vm";
98  
99      /** Name of the {@code Specification.java.vm} template. */
100     String SPECIFICATION_TEMPLATE = "Specification.java.vm";
101 
102     /** Name of the {@code specification-annotations.vm} template. */
103     String SPECIFICATION_ANNOTATIONS_TEMPLATE = "specification-annotations.vm";
104 
105     /** Name of the {@code implementation-annotations.vm} template. */
106     String IMPLEMENTATION_ANNOTATIONS_TEMPLATE = "implementation-annotations.vm";
107 
108 }