eu.planets_project.services.datatypes
Class Parameter

java.lang.Object
  eu.planets_project.services.datatypes.Parameter

public final class Parameter
extends java.lang.Object

This wraps the concept of a service parameter. When retrieved from a service, the default values should be set. This form does not allow optional v. required parameters, as ALL parameters should be explicitly specified. An 'optional' parameter implies an implicit default that would end up not being recorded in the audit trail.

Nested Class Summary

static class

Parameter.Builder Builder for Parameters with optional values (type, description).

Constructor Summary

Parameter(java.lang.String name, java.lang.String value)
Constructor for the most common case: a Parameter with name and value.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	getType()
java.lang.String	getValue()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value)

Constructor for the most common case: a Parameter with name and value. For parameters with optional values (type, description), use a Parameter.Builder.

Parameters:

name - A name for the parameter. Must be uniquely meaningful to the service, but is not expected to carry any meaning outwith the service.

value - The value for this parameter. Should be set to the default by the service when parameter discovery is happening.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getValue

public java.lang.String getValue()

Returns:

the value

getName

public java.lang.String getName()

Returns:

the name

getType

public java.lang.String getType()

Returns:

the type

getDescription

public java.lang.String getDescription()

Returns:

the description

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()