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

Class Siblings

java.lang.Object

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

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

com.github.dannil.scbjavaclient.model.livingconditions.families.siblings.Siblings

public class Siblings
extends AbstractTimeAndValueModel<Integer,Integer>

Model for siblings data.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
Siblings() Default constructor.
Siblings(String sex, String age, Integer siblingsLivingAtHome, String familyType, Integer year, List<ValueNode<Integer>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAge() Getter for age.
String	getFamilyType() Getter for family type.
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the siblings data from the API.
String	getSex() Getter for sex.
Integer	getSiblingsLivingAtHome() Getter for siblings living at home.
int	hashCode()
void	setAge(String age) Setter for age.
void	setFamilyType(String familyType) Setter for family type.
void	setSex(String sex) Setter for sex.
void	setSiblingsLivingAtHome(Integer siblingsLivingAtHome) Setter for siblings living at home.
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

Siblings

public Siblings()

Default constructor.

Siblings

public Siblings(String sex,
                String age,
                Integer siblingsLivingAtHome,
                String familyType,
                Integer year,
                List<ValueNode<Integer>> values)

Overloaded constructor.

Parameters:

sex - the sex

age - the age

siblingsLivingAtHome - the siblings living at home

familyType - the family type

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

getSiblingsLivingAtHome

public Integer getSiblingsLivingAtHome()

Getter for siblings living at home.

Returns:

the siblings living at home

setSiblingsLivingAtHome

public void setSiblingsLivingAtHome(Integer siblingsLivingAtHome)

Setter for siblings living at home.

Parameters:

siblingsLivingAtHome - the siblings living at home

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTimeAndValueModel<Integer,Integer>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractTimeAndValueModel<Integer,Integer>

toString

public String toString()

Specified by:

toString in class AbstractTimeAndValueModel<Integer,Integer>

getInputs

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

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

Returns:

a list of the available codes and their values