org.apache.qpid.management.domain.model
Class QpidArgument

java.lang.Object
  extended by org.apache.qpid.management.domain.model.QpidFeature
      extended by org.apache.qpid.management.domain.model.QpidAttribute
          extended by org.apache.qpid.management.domain.model.QpidProperty
              extended by org.apache.qpid.management.domain.model.QpidArgument

 class QpidArgument
extends QpidProperty

An argument is the formal definition of a parameter belonging to a specific method / operation.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.qpid.management.domain.model.QpidProperty
QpidProperty.Decoder, QpidProperty.NumberValidator, QpidProperty.StringValidator
 
Field Summary
 
Fields inherited from class org.apache.qpid.management.domain.model.QpidProperty
_decoder, _mandatoryPropertyDecoder, _optionalPropertyDecoder, EMPTY_VALIDATOR
 
Fields inherited from class org.apache.qpid.management.domain.model.QpidAttribute
_type, _unit
 
Fields inherited from class org.apache.qpid.management.domain.model.QpidFeature
_description, _name
 
Constructor Summary
QpidArgument()
           
 
Method Summary
 Object decode(org.apache.qpid.transport.codec.Decoder decoder)
          Decodes the value for this argument according to its type & definition.
 void encode(Object value, org.apache.qpid.transport.codec.Encoder encoder)
          Encodes the given value according to this argument type & definition.
 Object getDefaultValue()
          Returns the default value of this argument.
 Direction getDirection()
          Returns the direction of this argument.
 boolean isInput()
          Returns true if this is an Input argument.
 void setDefaultValue(Object defaultValue)
          Sets the default value of this argument.
 void setDirection(String code)
          Sets the direction of this argument.
 String toString()
          Returns the name of the feature.
 
Methods inherited from class org.apache.qpid.management.domain.model.QpidProperty
decodeValue, getAccessMode, getMaxLength, getMaxValue, getMinValue, isOptional, markAsOptional, setAccessMode, setMaxLength, setMaxValue, setMinValue, setType, validate
 
Methods inherited from class org.apache.qpid.management.domain.model.QpidAttribute
decodeValue, getJavaType, getUnit, setUnit
 
Methods inherited from class org.apache.qpid.management.domain.model.QpidFeature
getDescription, getName, setDescription, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QpidArgument

QpidArgument()
Method Detail

setDirection

public void setDirection(String code)
Sets the direction of this argument.

Parameters:
the - direction of this argument.

getDirection

public Direction getDirection()
Returns the direction of this argument.

Returns:
the direction of this argument.

setDefaultValue

public void setDefaultValue(Object defaultValue)
Sets the default value of this argument.

Parameters:
defaultValue - the default value of this argument.

getDefaultValue

public Object getDefaultValue()
Returns the default value of this argument.

Returns:
the default value of this argument.

isInput

public boolean isInput()
Returns true if this is an Input argument.

Returns:
true if this is an Input argument.

toString

public String toString()
Description copied from class: QpidFeature
Returns the name of the feature.

Overrides:
toString in class QpidAttribute
Returns:
the name of the feature.

encode

public void encode(Object value,
                   org.apache.qpid.transport.codec.Encoder encoder)
Encodes the given value according to this argument type & definition.

Parameters:
value - the value to be encoded.
encoder - the encoder.

decode

public Object decode(org.apache.qpid.transport.codec.Decoder decoder)
Decodes the value for this argument according to its type & definition.

Parameters:
decoder - the decoder
Returns:
the decoded value of this argument.


Licensed to the Apache Software Foundation