com.github.dannil.scbjavaclient.model

Class AbstractRegionYearAndValueModel<R,Y,V>

java.lang.Object

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

com.github.dannil.scbjavaclient.model.AbstractRegionYearAndValueModel<R,Y,V>

Type Parameters:

R - the region

Y - the year

V - the value

Direct Known Subclasses:

Area, AverageAge, FertilityRate, LiveBirth, MeanAgeFirstChild, Population

public abstract class AbstractRegionYearAndValueModel<R,Y,V>
extends AbstractValueModel<V>

Abstract model which handles region, year and value. Since these values are used by almost every single client response, this class will be extended by a majority of the implemented models.

Author:

Daniel Nilsson

Field Summary

Fields

Modifier and Type	Field and Description
protected R	region
protected Y	year

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

value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegionYearAndValueModel() Default constructor.
protected	AbstractRegionYearAndValueModel(R region, Y year, V value) Overloaded constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
R	getRegion() Getter for region
Y	getYear() Getter for year
int	hashCode()
void	setRegion(R region) Setter for
void	setYear(Y year) Setter for year
abstract String	toString()

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

getValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

region

protected R region

year

protected Y year

Constructor Detail

AbstractRegionYearAndValueModel

protected AbstractRegionYearAndValueModel()

Default constructor.

AbstractRegionYearAndValueModel

protected AbstractRegionYearAndValueModel(R region,
                               Y year,
                               V value)

Overloaded constructor.

Parameters:

region - the region

year - the year

value - the value

Method Detail

getRegion

public R getRegion()

Getter for region

Returns:

the region

setRegion

public void setRegion(R region)

Setter for

Parameters:

region - the region

getYear

public Y getYear()

Getter for year

Returns:

the year

setYear

public void setYear(Y year)

Setter for year

Parameters:

year - the year

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractValueModel<V>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractValueModel<V>

toString

public abstract String toString()

Specified by:

toString in class AbstractValueModel<V>