fixed some formatting typos
[vimdoclet.git] / sample / java.lang.reflect.Modifier.txt
blob9ee5c6482b3f900ad52579141667deeaa6242b3f
1 *java.lang.reflect.Modifier* *Modifier* The Modifier class provides static metho
3 public class Modifier
4   extends    |java.lang.Object|
6 |java.lang.reflect.Modifier_Description|
7 |java.lang.reflect.Modifier_Fields|
8 |java.lang.reflect.Modifier_Constructors|
9 |java.lang.reflect.Modifier_Methods|
11 ================================================================================
13 *java.lang.reflect.Modifier_Fields*
14 |int_java.lang.reflect.Modifier.ABSTRACT|
15 |int_java.lang.reflect.Modifier.FINAL|
16 |int_java.lang.reflect.Modifier.INTERFACE|
17 |int_java.lang.reflect.Modifier.NATIVE|
18 |int_java.lang.reflect.Modifier.PRIVATE|
19 |int_java.lang.reflect.Modifier.PROTECTED|
20 |int_java.lang.reflect.Modifier.PUBLIC|
21 |int_java.lang.reflect.Modifier.STATIC|
22 |int_java.lang.reflect.Modifier.STRICT|
23 |int_java.lang.reflect.Modifier.SYNCHRONIZED|
24 |int_java.lang.reflect.Modifier.TRANSIENT|
25 |int_java.lang.reflect.Modifier.VOLATILE|
27 *java.lang.reflect.Modifier_Constructors*
28 |java.lang.reflect.Modifier()|
30 *java.lang.reflect.Modifier_Methods*
31 |java.lang.reflect.Modifier.isAbstract(int)|Return true if the integer argument
32 |java.lang.reflect.Modifier.isFinal(int)|Return true if the integer argument in
33 |java.lang.reflect.Modifier.isInterface(int)|Return true if the integer argumen
34 |java.lang.reflect.Modifier.isNative(int)|Return true if the integer argument i
35 |java.lang.reflect.Modifier.isPrivate(int)|Return true if the integer argument 
36 |java.lang.reflect.Modifier.isProtected(int)|Return true if the integer argumen
37 |java.lang.reflect.Modifier.isPublic(int)|Return true if the integer argument i
38 |java.lang.reflect.Modifier.isStatic(int)|Return true if the integer argument i
39 |java.lang.reflect.Modifier.isStrict(int)|Return true if the integer argument i
40 |java.lang.reflect.Modifier.isSynchronized(int)|Return true if the integer argu
41 |java.lang.reflect.Modifier.isTransient(int)|Return true if the integer argumen
42 |java.lang.reflect.Modifier.isVolatile(int)|Return true if the integer argument
43 |java.lang.reflect.Modifier.toString(int)|Return a string describing the access
45 *java.lang.reflect.Modifier_Description*
47 The Modifier class provides static methods and constants to decode class and 
48 member access modifiers. The sets of modifiers are represented as integers with 
49 distinct bit positions representing different modifiers. The values for the 
50 constants representing the modifiers are taken from The JavaTM Virtual Machine 
51 Specification, Second edition tables 4.1, 4.4, 4.5, and 4.7. 
55 *int_java.lang.reflect.Modifier.ABSTRACT*
57 The int value representing the abstract modifier. 
60 *int_java.lang.reflect.Modifier.FINAL*
62 The int value representing the final modifier. 
65 *int_java.lang.reflect.Modifier.INTERFACE*
67 The int value representing the interface modifier. 
70 *int_java.lang.reflect.Modifier.NATIVE*
72 The int value representing the native modifier. 
75 *int_java.lang.reflect.Modifier.PRIVATE*
77 The int value representing the private modifier. 
80 *int_java.lang.reflect.Modifier.PROTECTED*
82 The int value representing the protected modifier. 
85 *int_java.lang.reflect.Modifier.PUBLIC*
87 The int value representing the public modifier. 
90 *int_java.lang.reflect.Modifier.STATIC*
92 The int value representing the static modifier. 
95 *int_java.lang.reflect.Modifier.STRICT*
97 The int value representing the strictfp modifier. 
100 *int_java.lang.reflect.Modifier.SYNCHRONIZED*
102 The int value representing the synchronized modifier. 
105 *int_java.lang.reflect.Modifier.TRANSIENT*
107 The int value representing the transient modifier. 
110 *int_java.lang.reflect.Modifier.VOLATILE*
112 The int value representing the volatile modifier. 
116 *java.lang.reflect.Modifier()*
118 public Modifier()
123 *java.lang.reflect.Modifier.isAbstract(int)*
125 public static boolean isAbstract(int mod)
127 Return true if the integer argument includes the abstract modifier, false 
128 otherwise. 
131     mod - a set of modifiers 
133     Returns: true if mod includes the abstract modifier; false otherwise. 
135 *java.lang.reflect.Modifier.isFinal(int)*
137 public static boolean isFinal(int mod)
139 Return true if the integer argument includes the final modifier, false 
140 otherwise. 
143     mod - a set of modifiers 
145     Returns: true if mod includes the final modifier; false otherwise. 
147 *java.lang.reflect.Modifier.isInterface(int)*
149 public static boolean isInterface(int mod)
151 Return true if the integer argument includes the interface modifier, false 
152 otherwise. 
155     mod - a set of modifiers 
157     Returns: true if mod includes the interface modifier; false otherwise. 
159 *java.lang.reflect.Modifier.isNative(int)*
161 public static boolean isNative(int mod)
163 Return true if the integer argument includes the native modifier, false 
164 otherwise. 
167     mod - a set of modifiers 
169     Returns: true if mod includes the native modifier; false otherwise. 
171 *java.lang.reflect.Modifier.isPrivate(int)*
173 public static boolean isPrivate(int mod)
175 Return true if the integer argument includes the private modifier, false 
176 otherwise. 
179     mod - a set of modifiers 
181     Returns: true if mod includes the private modifier; false otherwise. 
183 *java.lang.reflect.Modifier.isProtected(int)*
185 public static boolean isProtected(int mod)
187 Return true if the integer argument includes the protected modifier, false 
188 otherwise. 
191     mod - a set of modifiers 
193     Returns: true if mod includes the protected modifier; false otherwise. 
195 *java.lang.reflect.Modifier.isPublic(int)*
197 public static boolean isPublic(int mod)
199 Return true if the integer argument includes the public modifier, false 
200 otherwise. 
203     mod - a set of modifiers 
205     Returns: true if mod includes the public modifier; false otherwise. 
207 *java.lang.reflect.Modifier.isStatic(int)*
209 public static boolean isStatic(int mod)
211 Return true if the integer argument includes the static modifier, false 
212 otherwise. 
215     mod - a set of modifiers 
217     Returns: true if mod includes the static modifier; false otherwise. 
219 *java.lang.reflect.Modifier.isStrict(int)*
221 public static boolean isStrict(int mod)
223 Return true if the integer argument includes the strictfp modifier, false 
224 otherwise. 
227     mod - a set of modifiers 
229     Returns: true if mod includes the strictfp modifier; false otherwise. 
231 *java.lang.reflect.Modifier.isSynchronized(int)*
233 public static boolean isSynchronized(int mod)
235 Return true if the integer argument includes the synchronized modifier, false 
236 otherwise. 
239     mod - a set of modifiers 
241     Returns: true if mod includes the synchronized modifier; false otherwise. 
243 *java.lang.reflect.Modifier.isTransient(int)*
245 public static boolean isTransient(int mod)
247 Return true if the integer argument includes the transient modifier, false 
248 otherwise. 
251     mod - a set of modifiers 
253     Returns: true if mod includes the transient modifier; false otherwise. 
255 *java.lang.reflect.Modifier.isVolatile(int)*
257 public static boolean isVolatile(int mod)
259 Return true if the integer argument includes the volatile modifier, false 
260 otherwise. 
263     mod - a set of modifiers 
265     Returns: true if mod includes the volatile modifier; false otherwise. 
267 *java.lang.reflect.Modifier.toString(int)*
269 public static |java.lang.String| toString(int mod)
271 Return a string describing the access modifier flags in the specified modifier. 
272 For example: 
274 public final synchronized strictfp 
276 The modifier names are returned in an order consistent with the suggested 
277 modifier orderings given in The Java Language Specification, Second Edition 
278 sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1. The full modifier ordering used 
279 by this method is: 
281 public protected private abstract static final transient volatile synchronized 
282 native strictfp interface The interface modifier discussed in this class is not 
283 a true modifier in the Java language and it appears after all other modifiers 
284 listed by this method. This method may return a string of modifiers that are 
285 not valid modifiers of a Java entity; in other words, no checking is done on 
286 the possible validity of the combination of modifiers represented by the input. 
289     mod - a set of modifiers 
291     Returns: a string representation of the set of modifiers represented by mod