org.opennms.core.utils

Class Argument

java.lang.Object

org.opennms.core.utils.Argument

public class Argument
extends Object

This is a data class to store the argument information for a Command

Author:

Jason Johns

Constructor Summary

Constructors

Constructor and Description
Argument(String aSwitch, String sub, String value, boolean streamed) Default constructor, initializes the members

Method Summary

Methods

Modifier and Type	Method and Description
String	getSubstitution() Returns the substitution switch
String	getSwitch() Returns the switch
String	getValue() Returns the value of the argument
boolean	isStreamed() Returns the boolean indicating if this argument should be sent to an input stream.
void	setStreamed(boolean aBool) Sets the boolean indicating if this argument should be sent to an input stream
void	setSubstitution(String aValue) Sets the substitution switch
void	setSwitch(String aValue) Sets the switch member
void	setValue(String aValue) Sets the value of the argument
String	toString() Returns a string representation of the argument, for purposes of debugging

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument

public Argument(String aSwitch,
        String sub,
        String value,
        boolean streamed)

Default constructor, initializes the members

Parameters:

aSwitch - a String object.

sub - a String object.

value - a String object.

streamed - a boolean.

Method Detail

setSwitch

public void setSwitch(String aValue)

Sets the switch member

Parameters:

aValue - the value of the switch

setSubstitution

public void setSubstitution(String aValue)

Sets the substitution switch

Parameters:

aValue - the value of the substitution

setValue

public void setValue(String aValue)

Sets the value of the argument

Parameters:

aValue - the value of the argument

getSwitch

public String getSwitch()

Returns the switch

Returns:

String, the switch string

getSubstitution

public String getSubstitution()

Returns the substitution switch

Returns:

String, the substitution

getValue

public String getValue()

Returns the value of the argument

Returns:

String, the value of the argument

setStreamed

public void setStreamed(boolean aBool)

Sets the boolean indicating if this argument should be sent to an input stream

Parameters:

aBool - true if the argument should be sent to a input stream, false otherwise

isStreamed

public boolean isStreamed()

Returns the boolean indicating if this argument should be sent to an input stream.

Returns:

true if the argument should be sent to a input stream, false otherwise

toString

public String toString()

Returns a string representation of the argument, for purposes of debugging

Overrides:

toString in class Object

Returns:

String, a string representation