gov.nih.nlm.nls.lexAccess.Api

Class LexAccessHelp

java.lang.Object

gov.nih.nlm.nls.lexAccess.Api.LexAccessHelp

public class LexAccessHelp
extends java.lang.Object

This class is to print out help menu.

History:

• SCR-110, chlu, 12-21-15, thread safe fix

Version:

V-2016

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
LexAccessHelp()

Method Summary

Modifier and Type	Method and Description
static void	CategoryHelp(java.io.BufferedWriter bw, boolean fileOutput, gov.nih.nlm.nls.lvg.Util.Out out) Print out the LexAccess Category help menu.
static void	FormatHelp(java.io.BufferedWriter bw, boolean fileOutput, gov.nih.nlm.nls.lvg.Util.Out out) Print out the LexAccess format help menu.
static void	LexAccessHelp(java.io.BufferedWriter bw, boolean fileOutput, gov.nih.nlm.nls.lvg.Util.Out out) Print out LexAccess system help menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

LexAccessHelp

public LexAccessHelp()

Method Detail

LexAccessHelp

public static void LexAccessHelp(java.io.BufferedWriter bw,
                                 boolean fileOutput,
                                 gov.nih.nlm.nls.lvg.Util.Out out)

Print out LexAccess system help menu.

The option flags and command executions are defined in the classes of Flow and LexAccessCmdApi, respectively.

Parameters:

bw - buffer writer for standard out or file out

fileOutput - a flag to indicate if the buffer writer is a file output

out - out object

See Also:

LexAccessCmdApi

CategoryHelp

public static void CategoryHelp(java.io.BufferedWriter bw,
                                boolean fileOutput,
                                gov.nih.nlm.nls.lvg.Util.Out out)

Print out the LexAccess Category help menu.

Parameters:

bw - buffer writer for standard out or file out

fileOutput - a flag to indicate if the buffer writer is a file output

out - out object

FormatHelp

public static void FormatHelp(java.io.BufferedWriter bw,
                              boolean fileOutput,
                              gov.nih.nlm.nls.lvg.Util.Out out)

Print out the LexAccess format help menu.

Parameters:

bw - buffer writer for standard out or file out

fileOutput - a flag to indicate if the buffer writer is a file output

out - out object