fixed some formatting typos
[vimdoclet.git] / sample / java.lang.Appendable.txt
blob6a8bb96a7ce91a4af30201448d122596a7ef82ff
1 *java.lang.Appendable* *Appendable* An object to which char sequences and values
3 public interface interface Appendable
6 |java.lang.Appendable_Description|
7 |java.lang.Appendable_Fields|
8 |java.lang.Appendable_Constructors|
9 |java.lang.Appendable_Methods|
11 ================================================================================
13 *java.lang.Appendable_Methods*
14 |java.lang.Appendable.append(char)|Appends the specified character to this Appe
15 |java.lang.Appendable.append(CharSequence)|Appends the specified character sequ
16 |java.lang.Appendable.append(CharSequence,int,int)|Appends a subsequence of the
18 *java.lang.Appendable_Description*
20 An object to which char sequences and values can be appended. The Appendable 
21 interface must be implemented by any class whose instances are intended to 
22 receive formatted output from a (|java.util.Formatter|) . 
24 The characters to be appended should be valid Unicode characters as described 
25 in Unicode Character Representation. Note that supplementary characters may be 
26 composed of multiple 16-bit char values. 
28 Appendables are not necessarily safe for multithreaded access. Thread safety is 
29 the responsibility of classes that extend and implement this interface. 
31 Since this interface may be implemented by existing classes with different 
32 styles of error handling there is no guarantee that errors will be propagated 
33 to the invoker. 
37 *java.lang.Appendable.append(char)*
39 public |java.lang.Appendable| append(char c)
40   throws |java.io.IOException|
41          
42 Appends the specified character to this Appendable. 
45     c - The character to append 
47     Returns: A reference to this Appendable 
49 *java.lang.Appendable.append(CharSequence)*
51 public |java.lang.Appendable| append(java.lang.CharSequence csq)
52   throws |java.io.IOException|
53          
54 Appends the specified character sequence to this Appendable. 
56 Depending on which class implements the character sequence csq, the entire 
57 sequence may not be appended. For instance, if csq is a (|java.nio.CharBuffer|) 
58 then the subsequence to append is defined by the buffer's position and limit. 
61     csq - The character sequence to append. If csq is null, then the four characters 
62        "null" are appended to this Appendable. 
64     Returns: A reference to this Appendable 
66 *java.lang.Appendable.append(CharSequence,int,int)*
68 public |java.lang.Appendable| append(
69   java.lang.CharSequence csq,
70   int start,
71   int end)
72   throws |java.io.IOException|
73          
74 Appends a subsequence of the specified character sequence to this Appendable. 
76 An invocation of this method of the form out.append(csq, start, end) when csq 
77 is not null, behaves in exactly the same way as the invocation 
81 out.append(csq.subSequence(start, end)) 
84     csq - The character sequence from which a subsequence will be appended. If csq is 
85        null, then characters will be appended as if csq contained the four 
86        characters "null". 
87     start - The index of the first character in the subsequence 
88     end - The index of the character following the last character in the subsequence 
90     Returns: A reference to this Appendable