com.github.dannil.scbjavaclient.model

Class ResponseModel

java.lang.Object

com.github.dannil.scbjavaclient.model.ResponseModel

public class ResponseModel
extends Object

Class which encapsulates data retrieved from the API.

Since:

0.3.0

Constructor Summary

Constructors

Constructor and Description
ResponseModel() Default constructor.
ResponseModel(Map<String,String> variables, Collection<ValueNode<String>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ValueNode<String>	getValue(String code) Get the value node for a specific contents code.
Collection<ValueNode<String>>	getValues() Getter for values.
String	getVariable(String key) Get the variable value for a specific key.
Map<String,String>	getVariables() Getter for variables.
int	hashCode()
void	setValue(String code, String value) Set the value for a specific contents code.
void	setValues(Collection<ValueNode<String>> values) Setter for values.
void	setVariable(String key, String value) Set the variable value for a specific key.
void	setVariables(Map<String,String> variables) Setter for variables.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResponseModel

public ResponseModel()

Default constructor.

ResponseModel

public ResponseModel(Map<String,String> variables,
                     Collection<ValueNode<String>> values)

Overloaded constructor.

Parameters:

variables - the variables

values - the values

Method Detail

getVariables

public Map<String,String> getVariables()

Getter for variables.

Returns:

the variables

setVariables

public void setVariables(Map<String,String> variables)

Setter for variables.

Parameters:

variables - the variables

getValues

public Collection<ValueNode<String>> getValues()

Getter for values.

Returns:

the values

setValues

public void setValues(Collection<ValueNode<String>> values)

Setter for values.

Parameters:

values - the values

getVariable

public String getVariable(String key)

Get the variable value for a specific key.

Parameters:

key - the key

Returns:

the value

setVariable

public void setVariable(String key,
                        String value)

Set the variable value for a specific key.

Parameters:

key - the key

value - the value

getValue

public ValueNode<String> getValue(String code)

Get the value node for a specific contents code.

Parameters:

code - the contents code to get the ValueNode for

Returns:

the ValueNode containing the contents code

setValue

public void setValue(String code,
                     String value)

Set the value for a specific contents code.

Parameters:

code - the contents code to set the value for

value - the value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object