com.github.dannil.scbjavaclient.model.livingconditions.families.housing

Class Housing

java.lang.Object

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

com.github.dannil.scbjavaclient.model.AbstractTimeAndValueModel<Integer,String>

com.github.dannil.scbjavaclient.model.livingconditions.families.housing.Housing

public class Housing
extends AbstractTimeAndValueModel<Integer,String>

Model for housing data.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
Housing() Default constructor.
Housing(String sex, String age, String housingType, String familyType, String background, Integer parentIncome, Integer year, List<ValueNode<String>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAge() Getter for age.
String	getBackground() Getter for background.
String	getFamilyType() Getter for family type.
String	getHousingType() Getter for housing type.
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the housing data from the API.
Integer	getParentIncome() Getter for parent income.
String	getSex() Getter for sex.
int	hashCode()
void	setAge(String age) Setter for age.
void	setBackground(String background) Setter for background.
void	setFamilyType(String familyType) Setter for family type.
void	setHousingType(String housingType) Setter for housing type.
void	setParentIncome(Integer parentIncome) Setter for parent income.
void	setSex(String sex) Setter for sex.
String	toString()

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

getTime, setTime

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

Housing

public Housing()

Default constructor.

Housing

public Housing(String sex,
               String age,
               String housingType,
               String familyType,
               String background,
               Integer parentIncome,
               Integer year,
               List<ValueNode<String>> values)

Overloaded constructor.

Parameters:

sex - the sex

age - the age

housingType - the housing type

familyType - the family type

background - the background

parentIncome - the parent income

year - the year

values - the values

Method Detail

getSex

public String getSex()

Getter for sex.

Returns:

the sex

setSex

public void setSex(String sex)

Setter for sex.

Parameters:

sex - the sex

getAge

public String getAge()

Getter for age.

Returns:

the age

setAge

public void setAge(String age)

Setter for age.

Parameters:

age - the age

getHousingType

public String getHousingType()

Getter for housing type.

Returns:

the housing type

setHousingType

public void setHousingType(String housingType)

Setter for housing type.

Parameters:

housingType - the housing type

getFamilyType

public String getFamilyType()

Getter for family type.

Returns:

the family type

setFamilyType

public void setFamilyType(String familyType)

Setter for family type.

Parameters:

familyType - the family type

getBackground

public String getBackground()

Getter for background.

Returns:

the background

setBackground

public void setBackground(String background)

Setter for background.

Parameters:

background - the background

getParentIncome

public Integer getParentIncome()

Getter for parent income.

Returns:

the parent income

setParentIncome

public void setParentIncome(Integer parentIncome)

Setter for parent income.

Parameters:

parentIncome - the parent income

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTimeAndValueModel<Integer,String>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractTimeAndValueModel<Integer,String>

toString

public String toString()

Specified by:

toString in class AbstractTimeAndValueModel<Integer,String>

getInputs

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

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

Returns:

a list of the available codes and their values