com.github.dannil.scbjavaclient.model.environment.landandwaterarea

Class Area

java.lang.Object

com.github.dannil.scbjavaclient.model.AbstractValueModel<V>

com.github.dannil.scbjavaclient.model.AbstractYearAndValueModel<Y,V>

com.github.dannil.scbjavaclient.model.AbstractRegionYearAndValueModel<String,Integer,Double>

com.github.dannil.scbjavaclient.model.environment.landandwaterarea.Area

public class Area
extends AbstractRegionYearAndValueModel<String,Integer,Double>

Model for area data.

Since:

0.0.1

Field Summary

Fields inherited from class com.github.dannil.scbjavaclient.model.AbstractRegionYearAndValueModel

region

Fields inherited from class com.github.dannil.scbjavaclient.model.AbstractYearAndValueModel

year

Fields inherited from class com.github.dannil.scbjavaclient.model.AbstractValueModel

values

Constructor Summary

Constructors

Constructor and Description
Area() Default constructor.
Area(String region, String type, Integer year, List<ValueNode<Double>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the area data from the API.
String	getType() Getter for type.
int	hashCode()
void	setType(String type) Setter for type.
String	toString()

Methods inherited from class com.github.dannil.scbjavaclient.model.AbstractRegionYearAndValueModel

getRegion, setRegion

Methods inherited from class com.github.dannil.scbjavaclient.model.AbstractYearAndValueModel

getYear, setYear

Methods inherited from class com.github.dannil.scbjavaclient.model.AbstractValueModel

getValue, getValues, setValue, setValues

Methods inherited from class java.lang.Object

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

Constructor Detail

Area

public Area()

Default constructor.

Area

public Area(String region,
            String type,
            Integer year,
            List<ValueNode<Double>> values)

Overloaded constructor.

Parameters:

region - the region

type - the type

year - the year

values - the values

Method Detail

getType

public String getType()

Getter for type.

Returns:

the type

setType

public void setType(String type)

Setter for type.

Parameters:

type - the type

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRegionYearAndValueModel<String,Integer,Double>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractRegionYearAndValueModel<String,Integer,Double>

toString

public String toString()

Specified by:

toString in class AbstractRegionYearAndValueModel<String,Integer,Double>

getInputs

public static Map<String,Collection<String>> getInputs()

Get the available codes and their respective values for the area data from the API.

Returns:

a list of the available codes and their values