org.forgerock.openam.docs.ssoadm

Class SubCommandXML

java.lang.Object

org.forgerock.openam.docs.ssoadm.SubCommandXML

public class SubCommandXML
extends Object

Each ssoadm subcommand annotation is transformed to a DocBook 5 XML fragment for inclusion in the ssoadm refentry.

 
 <refsect2 xml:id="ssoadm-subcommand">
  <title>ssoadm subcommand</title>
  <para>description</para>
  <para>Usage: <literal>ssoadm subcommand --options [--global-options]</literal></para>
  <variablelist>
   <title>Options</title>
   <varlistentry>
    <term><option>--adminid, -u</option></term><!-- Mandatory -->
    <listitem><para>Administrator ID of running the command.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term><option>[--adminid, -u]</option></term><!-- Optional -->
    <listitem><para>Administrator ID of running the command.</para></listitem>
   </varlistentry>
  </variablelist>
 </refsect2>
 
 

Constructor Summary

Constructors

Constructor and Description
SubCommandXML()

Method Summary

Modifier and Type	Method and Description
static String	parseSubCommandInfo(String name, String desc, Collection<String> mandatory, Collection<String> optional) Transform SubCommandInfo annotation content to an XML fragment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubCommandXML

public SubCommandXML()

Method Detail

parseSubCommandInfo

public static String parseSubCommandInfo(String name,
                                         String desc,
                                         Collection<String> mandatory,
                                         Collection<String> optional)

Transform SubCommandInfo annotation content to an XML fragment.

Parameters:

name - Subcommand name

desc - Subcommand description string

mandatory - Subcommand mandatory options

optional - Subcommand optional options

Returns:

XML fragment documenting the annotation.