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

Class LegalGuardians

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.legalguardians.LegalGuardians

public class LegalGuardians
extends AbstractTimeAndValueModel<Integer,Integer>

Model for legal guardians data.

Since:

0.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCaregiver() Getter for caregiver.
String	getFamilyType() Getter for family type.
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the legal guardians data from the API.
String	getSex() Getter for sex.
int	hashCode()
void	setCaregiver(String caregiver) Setter for caregiver.
void	setFamilyType(String familyType) Setter for family type.
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

LegalGuardians

public LegalGuardians()

Default constructor.

LegalGuardians

public LegalGuardians(String sex,
                      String caregiver,
                      String familyType,
                      Integer year,
                      List<ValueNode<Integer>> values)

Overloaded constructor.

Parameters:

sex - the sex

caregiver - the caregiver

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

getCaregiver

public String getCaregiver()

Getter for caregiver.

Returns:

the caregiver

setCaregiver

public void setCaregiver(String caregiver)

Setter for caregiver.

Parameters:

caregiver - the caregiver

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 legal guardians data from the API.

Returns:

a list of the available codes and their values