org.forgerock.openam.docs.ssoadm

Class OptionXML

java.lang.Object

org.forgerock.openam.docs.ssoadm.OptionXML

public class OptionXML
extends Object

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

 
 <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>
 
 

Constructor Summary

Constructors

Constructor and Description
OptionXML()

Method Summary

Modifier and Type	Method and Description
static String	parseOption(String orig, boolean optional) Transform an option string to an XML fragment.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionXML

public OptionXML()

Method Detail

parseOption

public static String parseOption(String orig,
                                 boolean optional)

Transform an option string to an XML fragment.

Parameters:

orig - Option string such as "adminid|u|s|Administrator ID of running the command."

optional - If true, then enclose option string in [].

Returns:

XML fragment documenting the option.