gov.nih.nlm.nls.lvg.CmdLineSyntax

Class OptionFlag

java.lang.Object

gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionFlag

public class OptionFlag
extends java.lang.Object

This class OptionFlag represents an object of an option flag. An option flag is an item in a liked list. It includes name, parent, and child. An option flag may has none, one, or multiple argument(s). It's arguments are its children in the linked list format.

History:

Version:

V-2024

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
OptionFlag() Default constructor to create an option flag
OptionFlag(java.lang.String name, int level) Create an option flag, using the option item in string format and the level in the option hierarchy structure

Method Summary

Modifier and Type	Method and Description
OptionList<OptionFlag>	GetChild() Get the child OptionList of current OptinoFlag
java.lang.String	GetFullName() Get the full name of current optin flag
int	GetLevel() Get the level of current option flag form option hierarchical structure
java.lang.String	GetName() Get the name of current option flag
OptionFlag	GetParent() Get the parent of current OptionFlag
void	PrintInfo() Print detail information for the current OptionFlag
void	SetChild(OptionList<OptionFlag> child) Set the child of current optionFlag
void	SetFullName(java.lang.String fullName) Set the fullname of optionFlag
void	SetParent(OptionFlag parent) Set the parent of current optionFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionFlag

public OptionFlag()

Default constructor to create an option flag

OptionFlag

public OptionFlag(java.lang.String name,
                  int level)

Create an option flag, using the option item in string format and the level in the option hierarchy structure

Parameters:

name - long name of option

level - level of option in the optino tree

Method Detail

SetParent

public void SetParent(OptionFlag parent)

Set the parent of current optionFlag

Parameters:

parent - a parent OptionFlag

SetChild

public void SetChild(OptionList<OptionFlag> child)

Set the child of current optionFlag

Parameters:

child - child optionList

See Also:

OptionList

SetFullName

public void SetFullName(java.lang.String fullName)

Set the fullname of optionFlag

Parameters:

fullName - full name in a string format

GetLevel

public int GetLevel()

Get the level of current option flag form option hierarchical structure

Returns:

level of current option flag in the option hierarchy structure

GetName

public java.lang.String GetName()

Get the name of current option flag

Returns:

name of current option flag

GetFullName

public java.lang.String GetFullName()

Get the full name of current optin flag

Returns:

full name of current option flag

GetParent

public OptionFlag GetParent()

Get the parent of current OptionFlag

Returns:

parent OptionFlag of current option flag

GetChild

public OptionList<OptionFlag> GetChild()

Get the child OptionList of current OptinoFlag

Returns:

A list of OptionFlag - child OptionList of current option flag

PrintInfo

public void PrintInfo()

Print detail information for the current OptionFlag