Class ToolParameter

java.lang.Object

org.snmp4j.mcp.tool.ToolParameter

public class ToolParameter
extends Object

Describes a parameter that can be passed to a tool.

Since:

0.0.1

Version:

0.1.0

Author:

SNMP4J.org

Constructor Summary

Constructors

Constructor	Description
ToolParameter(String name, String description, boolean required, Class<?> type)	Creates a new tool parameter.
ToolParameter(String name, String description, boolean required, Class<?> type, Object defaultValue)	Creates a new tool parameter with a default value.

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()	Gets the default value.
String	getDescription()	Gets the parameter description.
String	getName()	Gets the parameter name.
Class<?>	getType()	Gets the parameter type.
boolean	isRequired()	Checks if the parameter is required.

Methods inherited from class Object

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

Constructor Details

ToolParameter

public ToolParameter(String name,
 String description,
 boolean required,
 Class<?> type)

Creates a new tool parameter.

Parameters:

name - the parameter name

description - the parameter description

required - whether the parameter is required

type - the parameter type

ToolParameter

public ToolParameter(String name,
 String description,
 boolean required,
 Class<?> type,
 Object defaultValue)

Creates a new tool parameter with a default value.

Parameters:

name - the parameter name

description - the parameter description

required - whether the parameter is required

type - the parameter type

defaultValue - the default value

Method Details

getName

public String getName()

Gets the parameter name.

Returns:

the parameter name

getDescription

public String getDescription()

Gets the parameter description.

Returns:

the parameter description

isRequired

public boolean isRequired()

Checks if the parameter is required.

Returns:

true if the parameter is required, false otherwise

getType

public Class<?> getType()

Gets the parameter type.

Returns:

the parameter type

getDefaultValue

public Object getDefaultValue()

Gets the default value.

Returns:

the default value, or null if there is no default