JavadocTagConstants


1   /*******************************************************************************
2    * Copyright (c) 2000, 2007 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.jdt.internal.compiler.parser;
13  
14  /**
15   * Javadoc tag constants.
16   *
17   * @since 3.2
18   */
19  public interface JavadocTagConstants {
20  
21      // recognized tags
22      public static final char[] TAG_DEPRECATED = "deprecated".toCharArray(); //$NON-NLS-1$
23      public static final char[] TAG_PARAM = "param".toCharArray(); //$NON-NLS-1$
24      public static final char[] TAG_RETURN = "return".toCharArray(); //$NON-NLS-1$
25      public static final char[] TAG_THROWS = "throws".toCharArray(); //$NON-NLS-1$
26      public static final char[] TAG_EXCEPTION = "exception".toCharArray(); //$NON-NLS-1$
27      public static final char[] TAG_SEE = "see".toCharArray(); //$NON-NLS-1$
28      public static final char[] TAG_LINK = "link".toCharArray(); //$NON-NLS-1$
29      public static final char[] TAG_LINKPLAIN = "linkplain".toCharArray(); //$NON-NLS-1$
30      public static final char[] TAG_INHERITDOC = "inheritDoc".toCharArray(); //$NON-NLS-1$
31      public static final char[] TAG_VALUE = "value".toCharArray(); //$NON-NLS-1$
32      public static final char[] TAG_AUTHOR = "author".toCharArray(); //$NON-NLS-1$
33      public static final char[] TAG_CODE = "code".toCharArray(); //$NON-NLS-1$
34      public static final char[] TAG_DOC_ROOT = "docRoot".toCharArray(); //$NON-NLS-1$
35      public static final char[] TAG_LITERAL = "literal".toCharArray(); //$NON-NLS-1$
36      public static final char[] TAG_SERIAL = "serial".toCharArray(); //$NON-NLS-1$
37      public static final char[] TAG_SERIAL_DATA = "serialData".toCharArray(); //$NON-NLS-1$
38      public static final char[] TAG_SERIAL_FIELD = "serialField".toCharArray(); //$NON-NLS-1$
39      public static final char[] TAG_SINCE = "since".toCharArray(); //$NON-NLS-1$
40      public static final char[] TAG_VERSION = "version".toCharArray(); //$NON-NLS-1$
41      public static final char[] TAG_CATEGORY = "category".toCharArray(); //$NON-NLS-1$
42  
43      // tags lengthes
44      public static final int TAG_DEPRECATED_LENGTH = TAG_DEPRECATED.length;
45      public static final int TAG_PARAM_LENGTH = TAG_PARAM.length;
46      public static final int TAG_RETURN_LENGTH = TAG_RETURN.length;
47      public static final int TAG_THROWS_LENGTH = TAG_THROWS.length;
48      public static final int TAG_EXCEPTION_LENGTH = TAG_EXCEPTION.length;
49      public static final int TAG_SEE_LENGTH = TAG_SEE.length;
50      public static final int TAG_LINK_LENGTH = TAG_LINK.length;
51      public static final int TAG_LINKPLAIN_LENGTH = TAG_LINKPLAIN.length;
52      public static final int TAG_INHERITDOC_LENGTH = TAG_INHERITDOC.length;
53      public static final int TAG_VALUE_LENGTH = TAG_VALUE.length;
54      public static final int TAG_CATEGORY_LENGTH = TAG_CATEGORY.length;
55  
56  
57      // tags value
58      public static final int NO_TAG_VALUE = 0;
59      public static final int TAG_DEPRECATED_VALUE = 1;
60      public static final int TAG_PARAM_VALUE = 2;
61      public static final int TAG_RETURN_VALUE = 3;
62      public static final int TAG_THROWS_VALUE = 4;
63      public static final int TAG_EXCEPTION_VALUE = 5;
64      public static final int TAG_SEE_VALUE = 6;
65      public static final int TAG_LINK_VALUE = 7;
66      public static final int TAG_LINKPLAIN_VALUE = 8;
67      public static final int TAG_INHERITDOC_VALUE = 9;
68      public static final int TAG_VALUE_VALUE = 10;
69      public static final int TAG_CATEGORY_VALUE = 11;
70      public static final int TAG_OTHERS_VALUE = 100;
71      
72      // tags expected positions
73      public final static int ORDERED_TAGS_NUMBER = 3;
74      public final static int PARAM_TAG_EXPECTED_ORDER = 0;
75      public final static int THROWS_TAG_EXPECTED_ORDER = 1;
76      public final static int SEE_TAG_EXPECTED_ORDER = 2;
77  
78      /*
79       * Tag kinds indexes
80       */
81      public final static int BLOCK_IDX = 0;
82      public final static int INLINE_IDX = 1;
83  
84      /*
85       * Tags versions
86       */
87      public static final char[][][] BLOCK_TAGS = {
88          // since 1.0
89          { TAG_AUTHOR, TAG_DEPRECATED, TAG_EXCEPTION, TAG_PARAM, TAG_RETURN, TAG_SEE, TAG_VERSION, TAG_CATEGORY /* 1.6 tag but put here as we support it for all compliances */ },
90          // since 1.1
91          { TAG_SINCE },
92          // since 1.2
93          { TAG_SERIAL, TAG_SERIAL_DATA, TAG_SERIAL_FIELD , TAG_THROWS },
94          // since 1.3
95          {},
96          // since 1.4
97          {},
98          // since 1.5
99          {},
100         // since 1.6
101         {},
102         // since 1.7
103         {},
104     };
105     public static final char[][][] INLINE_TAGS = {
106         // since 1.0
107         {},
108         // since 1.1
109         {},
110         // since 1.2
111         { TAG_LINK },
112         // since 1.3
113         { TAG_DOC_ROOT },
114         // since 1.4
115         { TAG_INHERITDOC, TAG_LINKPLAIN, TAG_VALUE },
116         // since 1.5
117         { TAG_CODE, TAG_LITERAL },
118         // since 1.6
119         {},
120         // since 1.7
121         {},
122     };
123     public final static int INLINE_TAGS_LENGTH = INLINE_TAGS.length;
124     public final static int BLOCK_TAGS_LENGTH = BLOCK_TAGS.length;
125     public final static int ALL_TAGS_LENGTH = BLOCK_TAGS_LENGTH+INLINE_TAGS_LENGTH;
126 
127     /*
128      * Tags usage
129      */
130     public static final char[][] PACKAGE_TAGS = {
131         TAG_SEE,
132         TAG_SINCE,
133         TAG_SERIAL,
134         TAG_AUTHOR,
135         TAG_VERSION,
136         TAG_CATEGORY,
137         TAG_LINK,
138         TAG_LINKPLAIN,
139         TAG_DOC_ROOT,
140         TAG_VALUE,
141     };
142     public static final char[][] CLASS_TAGS = {
143         TAG_SEE,
144         TAG_SINCE,
145         TAG_DEPRECATED,
146         TAG_SERIAL,
147         TAG_AUTHOR,
148         TAG_VERSION,
149         TAG_PARAM,
150         TAG_CATEGORY,
151         TAG_LINK,
152         TAG_LINKPLAIN,
153         TAG_DOC_ROOT,
154         TAG_VALUE,
155         TAG_CODE,
156         TAG_LITERAL
157     };
158     public static final char[][] FIELD_TAGS = {
159         TAG_SEE,
160         TAG_SINCE,
161         TAG_DEPRECATED,
162         TAG_SERIAL,
163         TAG_SERIAL_FIELD,
164         TAG_CATEGORY,
165         TAG_LINK,
166         TAG_LINKPLAIN,
167         TAG_DOC_ROOT,
168         TAG_VALUE,
169         TAG_CODE,
170         TAG_LITERAL
171     };
172     public static final char[][] METHOD_TAGS = {
173         TAG_SEE,
174         TAG_SINCE,
175         TAG_DEPRECATED,
176         TAG_PARAM,
177         TAG_RETURN,
178         TAG_THROWS,
179         TAG_EXCEPTION,
180         TAG_SERIAL_DATA,
181         TAG_CATEGORY,
182         TAG_LINK,
183         TAG_LINKPLAIN,
184         TAG_INHERITDOC,
185         TAG_DOC_ROOT,
186         TAG_VALUE,
187         TAG_CODE,
188         TAG_LITERAL
189     };
190 }
191
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags