Improved build.xml
[vimdoclet.git] / sample / java.util.logging.SocketHandler.txt
blobc45a796c216777c39a4b218d85492416302fa5b3
1 *java.util.logging.SocketHandler* *SocketHandler* Simple network logging Handler
3 public class SocketHandler
4   extends    |java.util.logging.StreamHandler|
6 |java.util.logging.SocketHandler_Description|
7 |java.util.logging.SocketHandler_Fields|
8 |java.util.logging.SocketHandler_Constructors|
9 |java.util.logging.SocketHandler_Methods|
11 ================================================================================
13 *java.util.logging.SocketHandler_Constructors*
14 |java.util.logging.SocketHandler()|Create a SocketHandler, using only LogManage
15 |java.util.logging.SocketHandler(String,int)|Construct a SocketHandler using a 
17 *java.util.logging.SocketHandler_Methods*
18 |java.util.logging.SocketHandler.close()|Close this output stream.
19 |java.util.logging.SocketHandler.publish(LogRecord)|Format and publish a LogRec
21 *java.util.logging.SocketHandler_Description*
23 Simple network logging Handler. 
25 LogRecords are published to a network stream connection. By default the 
26 XMLFormatter class is used for formatting. 
28 Configuration: By default each SocketHandler is initialized using the following 
29 LogManager configuration properties. If properties are not defined (or have 
30 invalid values) then the specified default values are used. 
32 java.util.logging.SocketHandler.level specifies the default level for the 
33 Handler (defaults to Level.ALL). java.util.logging.SocketHandler.filter 
34 specifies the name of a Filter class to use (defaults to no Filter). 
35 java.util.logging.SocketHandler.formatter specifies the name of a Formatter 
36 class to use (defaults to java.util.logging.XMLFormatter). 
37 java.util.logging.SocketHandler.encoding the name of the character set encoding 
38 to use (defaults to the default platform encoding). 
39 java.util.logging.SocketHandler.host specifies the target host name to connect 
40 to (no default). java.util.logging.SocketHandler.port specifies the target TCP 
41 port to use (no default). 
43 The output IO stream is buffered, but is flushed after each LogRecord is 
44 written. 
47 *java.util.logging.SocketHandler()*
49 public SocketHandler()
50   throws |java.io.IOException|
51          
52 Create a SocketHandler, using only LogManager properties (or their defaults). 
55 *java.util.logging.SocketHandler(String,int)*
57 public SocketHandler(
58   java.lang.String host,
59   int port)
60   throws |java.io.IOException|
61          
62 Construct a SocketHandler using a specified host and port. 
64 The SocketHandler is configured based on LogManager properties (or their 
65 default values) except that the given target host and port arguments are used. 
66 If the host argument is empty, but not null String then the localhost is used. 
68     host - target host. 
69     port - target port. 
71 *java.util.logging.SocketHandler.close()*
73 public synchronized void close()
74   throws |java.lang.SecurityException|
75          
76 Close this output stream. 
79 *java.util.logging.SocketHandler.publish(LogRecord)*
81 public synchronized void publish(java.util.logging.LogRecord record)
83 Format and publish a LogRecord. 
85     record - description of the log event. A null record is silently ignored and is not 
86        published