User: d_jencks
  Date: 02/04/05 20:12:56

  Added:       core/src/xdoclet/jmx/vendor JBossXmlDocSubTask.java
  Log:
  added jmx mbean documentation generation (to docbook) tsubtask
  
  Revision  Changes    Path
  1.1                  xdoclet/core/src/xdoclet/jmx/vendor/JBossXmlDocSubTask.java
  
  Index: JBossXmlDocSubTask.java
  ===================================================================
  /*
   * Copyright (c) 2001,2002 The XDoclet team
   * All rights reserved.
   */
  package xdoclet.jmx.vendor;
  
  import xdoclet.XmlSubTask;
  import xdoclet.XDocletException;
  import xdoclet.util.Translator;
  
  import java.io.File;
  
  /**
   * Generates a skeleton {0}-service.xml file for JBoss mbean configuration. This
   * can help you see what you can set in an mbean, you can just fill in your
   * values and deploy. Currently there is a limitation that only managed
   * attributes with getters show up in the results, however there is a comment
   * for those with only a setter. It treats read-only managed attributes as if
   * they can be written.
   *
   * @author    <a href="mailto:[EMAIL PROTECTED]";>David Jencks</a>
   * @created   April 4, 2002
   * @version   $$
   */
  
  public class JBossXmlDocSubTask extends XmlSubTask
  {
        /**
         * @todo-javadoc   Describe the field
         */
        public final static String SUBTASK_NAME = "jbossXmlDoc";
  
        /**
         * @todo-javadoc   Describe the field
         */
        private final static String DD_FILE_NAME = "{0}-doc.xml";
        private final static String DD_PUBLICID = "-//OASIS//DTD DocBook XML 
V4.1.2//EN";
        private final static String DD_SYSTEMID = 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";;
        //private final static String DTD_FILE_NAME = "";
  
        /**
         * @todo-javadoc   Describe the field
         */
        private static String DEFAULT_TEMPLATE_FILE = 
"/xdoclet/jmx/vendor/jbossmx-xml-doc.j";
  
        /**
         * Describe what the JBossXmlDocSubTask constructor does
         *
         * @todo-javadoc   Write javadocs for constructor
         */
        public JBossXmlDocSubTask()
        {
                setTemplateURL( getClass().getResource( DEFAULT_TEMPLATE_FILE ) );
                setDestinationFile( DD_FILE_NAME );
                setHavingClassTag( "jmx:mbean" );
                setPublicId( DD_PUBLICID );
                setSystemId( DD_SYSTEMID );
  
        }
  
        /**
         * Gets the SubTaskName attribute of the JBossXmlServiceTemplateSubTask object
         *
         * @return   The SubTaskName value
         */
        public String getSubTaskName()
        {
                return SUBTASK_NAME;
        }
  
  }
  
  
  

_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel

Reply via email to