Syslog White Paper FAQ Examples JavaDoc Classloader
Protomatter Software v1.1.7

com.protomatter.syslog.xml
Class JDK14SyslogTextFormatter_Helper

java.lang.Object
  |
  +--com.protomatter.syslog.xml.SimpleSyslogTextFormatter_Helper
        |
        +--com.protomatter.syslog.xml.JDK14SyslogTextFormatter_Helper
All Implemented Interfaces:
XMLConfigHelper

public class JDK14SyslogTextFormatter_Helper
extends SimpleSyslogTextFormatter_Helper

XML configuration helper for JDK14SyslogTextFormatter.


Constructor Summary
JDK14SyslogTextFormatter_Helper()
           
 
Method Summary
 void configure(java.lang.Object o, org.jdom.Element e)
          Configure this text formatter given the XML element.
 org.jdom.Element getConfiguration(java.lang.Object o, org.jdom.Element element)
          Encode the given object's configuration into the given XML element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JDK14SyslogTextFormatter_Helper

public JDK14SyslogTextFormatter_Helper()
Method Detail

configure

public void configure(java.lang.Object o,
                      org.jdom.Element e)
               throws SyslogInitException
Configure this text formatter given the XML element. The <Format> element should look like this:



  <Format class="com.protomatter.syslog.JDK14SyslogTextFormatter" >

    <!--
     Config params from SimpleSyslogTextFormatter_Helper can
     get inserted here.
    -->

    <overrideClassName>true|false</overrideClassName>
    <includeMethod>true|false</includeMethod>
    <includeLineNumber>true|false</includeLineNumber>

  </Format>
  

Element
name value required
overrideClass true or false -- decide if the formatter should override the class name with one automatically determined. no (default is true)
includeMethod true or false -- decide if the logger should include the method name in the class portion of the log. This has no effect unless the overrideClass option is set to true. no (default is true)
includeLineNumber true or false -- decide if the logger should include the line number in the class portion of the log. This has no effect unless the includeMethod option is set to true. no (default is true)

Overrides:
configure in class SimpleSyslogTextFormatter_Helper

getConfiguration

public org.jdom.Element getConfiguration(java.lang.Object o,
                                         org.jdom.Element element)
Description copied from interface: XMLConfigHelper
Encode the given object's configuration into the given XML element.
Overrides:
getConfiguration in class SimpleSyslogTextFormatter_Helper

Protomatter Software v1.1.7
Copyright 1998-2002 Nate Sammons

Protomatter Software v1.1.7 http://protomatter.sourceforge.net/1.1.7