davetron5000 / vimdoclet

Javadoc doclet that generates VIM helpfiles

This URL has Read+Write access

vimdoclet / sample / java.lang.Byte.txt
100644 346 lines (199 sloc) 10.557 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
*java.lang.Byte* *Byte* The Byte class wraps a value of primitive type
 byte in
 
public final class Byte
  extends |java.lang.Number|
  implements |java.lang.Comparable|
 
|java.lang.Byte_Description|
|java.lang.Byte_Fields|
|java.lang.Byte_Constructors|
|java.lang.Byte_Methods|
 
================================================================================
 
*java.lang.Byte_Fields*
|byte_java.lang.Byte.MAX_VALUE|
|byte_java.lang.Byte.MIN_VALUE|
|int_java.lang.Byte.SIZE|
|java.lang.Class<java.lang.Byte>_java.lang.Byte.TYPE|
 
*java.lang.Byte_Constructors*
|java.lang.Byte(byte)|Constructs a newly allocated Byte object that represents
|java.lang.Byte(String)|Constructs a newly allocated Byte object that represen
 
*java.lang.Byte_Methods*
|java.lang.Byte.byteValue()|Returns the value of this Byte as a byte.
|java.lang.Byte.compareTo(Byte)|Compares two Byte objects numerically.
|java.lang.Byte.decode(String)|Decodes a String into a Byte.
|java.lang.Byte.doubleValue()|Returns the value of this Byte as a double.
|java.lang.Byte.equals(Object)|Compares this object to the specified object.
|java.lang.Byte.floatValue()|Returns the value of this Byte as a float.
|java.lang.Byte.hashCode()|Returns a hash code for this Byte.
|java.lang.Byte.intValue()|Returns the value of this Byte as an int.
|java.lang.Byte.longValue()|Returns the value of this Byte as a long.
|java.lang.Byte.parseByte(String)|Parses the string argument as a signed decima
|java.lang.Byte.parseByte(String,int)|Parses the string argument as a signed by
|java.lang.Byte.shortValue()|Returns the value of this Byte as a short.
|java.lang.Byte.toString()|Returns a String object representing this Byte's va
|java.lang.Byte.toString(byte)|Returns a new String object representing the sp
|java.lang.Byte.valueOf(byte)|Returns a Byte instance representing the specifie
|java.lang.Byte.valueOf(String)|Returns a Byte object holding the value given
|java.lang.Byte.valueOf(String,int)|Returns a Byte object holding the value ex
 
*java.lang.Byte_Description*
 
The Byte class wraps a value of primitive type byte in an object. An object of
type Byte contains a single field whose type is byte.
 
 
 
In addition, this class provides several methods for converting a byte to a
String and a String to a byte, as well as other constants and methods useful
when dealing with a byte.
 
 
 
*byte_java.lang.Byte.MAX_VALUE*
 
A constant holding the maximum value a byte can have, 27-1.
 
 
*byte_java.lang.Byte.MIN_VALUE*
 
A constant holding the minimum value a byte can have, -27.
 
 
*int_java.lang.Byte.SIZE*
 
The number of bits used to represent a byte value in two's complement binary
form.
 
 
*java.lang.Class<java.lang.Byte>_java.lang.Byte.TYPE*
 
The Class instance representing the primitive type byte.
 
 
 
*java.lang.Byte(byte)*
 
public Byte(byte value)
 
Constructs a newly allocated Byte object that represents the specified byte
value.
 
    value - the value to be represented by the Byte.
 
*java.lang.Byte(String)*
 
public Byte(java.lang.String s)
  throws |java.lang.NumberFormatException|
         
Constructs a newly allocated Byte object that represents the byte value
indicated by the String parameter. The string is converted to a byte value in
exactly the manner used by the parseByte method for radix 10.
 
    s - the String to be converted to a Byte
 
*java.lang.Byte.byteValue()*
 
public byte byteValue()
 
Returns the value of this Byte as a byte.
 
 
 
*java.lang.Byte.compareTo(Byte)*
 
public int compareTo(java.lang.Byte anotherByte)
 
Compares two Byte objects numerically.
 
 
    anotherByte - the Byte to be compared.
 
    Returns: the value 0 if this Byte is equal to the argument Byte; a value less than 0 if
             this Byte is numerically less than the argument Byte; and a value
             greater than 0 if this Byte is numerically greater than the
             argument Byte (signed comparison).
 
*java.lang.Byte.decode(String)*
 
public static |java.lang.Byte| decode(java.lang.String nm)
  throws |java.lang.NumberFormatException|
         
Decodes a String into a Byte. Accepts decimal, hexadecimal, and octal numbers
given by the following grammar:
 
 
 
DecodableString: Signopt DecimalNumeral Signopt 0x HexDigits Signopt 0X
HexDigits Signopt # HexDigits Signopt 0 OctalDigits
 
Sign: -
 
 
 
DecimalNumeral, HexDigits, and OctalDigits are defined in 3.10.1 of the Java
Language Specification.
 
The sequence of characters following an (optional) negative sign and/or radix
specifier (0x, 0X, #, or leading zero) is parsed as by the Byte.parseByte
method with the indicated radix (10, 16, or 8). This sequence of characters
must represent a positive value or a (|java.lang.NumberFormatException|) will
be thrown. The result is negated if first character of the specified String is
the minus sign. No whitespace characters are permitted in the String.
 
 
    nm - the String to decode.
 
    Returns: a Byte object holding the byte value represented by nm
 
*java.lang.Byte.doubleValue()*
 
public double doubleValue()
 
Returns the value of this Byte as a double.
 
 
 
*java.lang.Byte.equals(Object)*
 
public boolean equals(java.lang.Object obj)
 
Compares this object to the specified object. The result is true if and only if
the argument is not null and is a Byte object that contains the same byte value
as this object.
 
 
    obj - the object to compare with
 
    Returns: true if the objects are the same; false otherwise.
 
*java.lang.Byte.floatValue()*
 
public float floatValue()
 
Returns the value of this Byte as a float.
 
 
 
*java.lang.Byte.hashCode()*
 
public int hashCode()
 
Returns a hash code for this Byte.
 
 
 
*java.lang.Byte.intValue()*
 
public int intValue()
 
Returns the value of this Byte as an int.
 
 
 
*java.lang.Byte.longValue()*
 
public long longValue()
 
Returns the value of this Byte as a long.
 
 
 
*java.lang.Byte.parseByte(String)*
 
public static byte parseByte(java.lang.String s)
  throws |java.lang.NumberFormatException|
         
Parses the string argument as a signed decimal byte. The characters in the
string must all be decimal digits, except that the first character may be an
ASCII minus sign '-' ('u002D') to indicate a negative value. The resulting byte
value is returned, exactly as if the argument and the radix 10 were given as
arguments to the (|java.lang.Byte|) method.
 
 
    s - a String containing the byte representation to be parsed
 
    Returns: the byte value represented by the argument in decimal
 
*java.lang.Byte.parseByte(String,int)*
 
public static byte parseByte(
  java.lang.String s,
  int radix)
  throws |java.lang.NumberFormatException|
         
Parses the string argument as a signed byte in the radix specified by the
second argument. The characters in the string must all be digits, of the
specified radix (as determined by whether (|java.lang.Character|) returns a
nonnegative value) except that the first character may be an ASCII minus sign
'-' ('u002D') to indicate a negative value. The resulting byte value is
returned.
 
An exception of type NumberFormatException is thrown if any of the following
situations occurs:
 
The first argument is null or is a string of length zero.
 
The radix is either smaller than (|java.lang.Character|) or larger than
(|java.lang.Character|) .
 
Any character of the string is not a digit of the specified radix, except that
the first character may be a minus sign '-' ('u002D') provided that the string
is longer than length 1.
 
The value represented by the string is not a value of type byte.
 
 
    s - the String containing the byte representation to be parsed
    radix - the radix to be used while parsing s
 
    Returns: the byte value represented by the string argument in the specified radix
 
*java.lang.Byte.shortValue()*
 
public short shortValue()
 
Returns the value of this Byte as a short.
 
 
 
*java.lang.Byte.toString()*
 
public |java.lang.String| toString()
 
Returns a String object representing this Byte's value. The value is converted
to signed decimal representation and returned as a string, exactly as if the
byte value were given as an argument to the (|java.lang.Byte|) method.
 
 
 
    Returns: a string representation of the value of this object in base10.
 
*java.lang.Byte.toString(byte)*
 
public static |java.lang.String| toString(byte b)
 
Returns a new String object representing the specified byte. The radix is
assumed to be 10.
 
 
    b - the byte to be converted
 
    Returns: the string representation of the specified byte
 
*java.lang.Byte.valueOf(byte)*
 
public static |java.lang.Byte| valueOf(byte b)
 
Returns a Byte instance representing the specified byte value. If a new Byte
instance is not required, this method should generally be used in preference to
the constructor (|java.lang.Byte|) , as this method is likely to yield
significantly better space and time performance by caching frequently requested
values.
 
 
    b - a byte value.
 
    Returns: a Byte instance representing b.
 
*java.lang.Byte.valueOf(String)*
 
public static |java.lang.Byte| valueOf(java.lang.String s)
  throws |java.lang.NumberFormatException|
         
Returns a Byte object holding the value given by the specified String. The
argument is interpreted as representing a signed decimal byte, exactly as if
the argument were given to the (|java.lang.Byte|) method. The result is a Byte
object that represents the byte value specified by the string. In other words,
this method returns a Byte object equal to the value of:
 
new Byte(Byte.parseByte(s))
 
 
    s - the string to be parsed
 
    Returns: a Byte object holding the value represented by the string argument
 
*java.lang.Byte.valueOf(String,int)*
 
public static |java.lang.Byte| valueOf(
  java.lang.String s,
  int radix)
  throws |java.lang.NumberFormatException|
         
Returns a Byte object holding the value extracted from the specified String
when parsed with the radix given by the second argument. The first argument is
interpreted as representing a signed byte in the radix specified by the second
argument, exactly as if the argument were given to the (|java.lang.Byte|)
method. The result is a Byte object that represents the byte value specified by
the string. In other words, this method returns a Byte object equal to the
value of:
 
new Byte(Byte.parseByte(s, radix))
 
 
    s - the string to be parsed
    radix - the radix to be used in interpreting s
 
    Returns: a Byte object holding the value represented by the string argument in the
             specified radix.