it.jnrpe.plugins
Class PluginOption

java.lang.Object
  it.jnrpe.plugins.PluginOption

public class PluginOption
extends Object

This class describes a plugin option

Author:

Massimiliano Ziccardi

Constructor Summary

PluginOption()

Method Summary

String	getArgName()
Integer	getArgsCount()
Boolean	getArgsOptional()
String	getDescription()
String	getLongOpt()
String	getOption() Returns the option string
String	getRequired()
String	getType()
String	getValueSeparator()
boolean	hasArgs() Returns true if the option has an argument
PluginOption	setArgName(String sArgName)
PluginOption	setArgsCount(Integer iArgCount)
PluginOption	setArgsOptional(Boolean bArgsOptional)
PluginOption	setDescription(String sDescription)
PluginOption	setHasArgs(boolean bHasArgs)
PluginOption	setLongOpt(String sLongOpt)
PluginOption	setOption(String sOption) Sets the option string.
PluginOption	setRequired(boolean bRequired)
PluginOption	setType(String sType)
PluginOption	setValueSeparator(String sValueSeparator)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginOption

public PluginOption()

Method Detail

getOption

public String getOption()

Returns the option string

Returns:

setOption

public PluginOption setOption(String sOption)

Sets the option string. For example, if the plugin must receive the '--file' option, sOption will be 'file'.

Parameters:

sOption -

Returns:

hasArgs

public boolean hasArgs()

Returns true if the option has an argument

Returns:

setHasArgs

public PluginOption setHasArgs(boolean bHasArgs)

getArgsCount

public Integer getArgsCount()

setArgsCount

public PluginOption setArgsCount(Integer iArgCount)

getRequired

public String getRequired()

setRequired

public PluginOption setRequired(boolean bRequired)

getArgsOptional

public Boolean getArgsOptional()

setArgsOptional

public PluginOption setArgsOptional(Boolean bArgsOptional)

getArgName

public String getArgName()

setArgName

public PluginOption setArgName(String sArgName)

getLongOpt

public String getLongOpt()

setLongOpt

public PluginOption setLongOpt(String sLongOpt)

getType

public String getType()

setType

public PluginOption setType(String sType)

getValueSeparator

public String getValueSeparator()

setValueSeparator

public PluginOption setValueSeparator(String sValueSeparator)

getDescription

public String getDescription()

setDescription

public PluginOption setDescription(String sDescription)