com.github.dannil.scbjavaclient.model.energy.annualstatistics

Class ElectricitySupply

java.lang.Object

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

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

com.github.dannil.scbjavaclient.model.energy.annualstatistics.ElectricitySupply

public class ElectricitySupply
extends AbstractTimeAndValueModel<Integer,Integer>

Model for electricity supply data.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
ElectricitySupply() Default constructor.
ElectricitySupply(String powerPlant, Integer year, List<ValueNode<Integer>> 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 electricity supply data from the API.
String	getPowerPlant() Getter for power plant.
int	hashCode()
void	setPowerPlant(String powerPlant) Setter for power plant.
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

ElectricitySupply

public ElectricitySupply()

Default constructor.

ElectricitySupply

public ElectricitySupply(String powerPlant,
                         Integer year,
                         List<ValueNode<Integer>> values)

Overloaded constructor.

Parameters:

powerPlant - the power plant

year - the year

values - the values

Method Detail

getPowerPlant

public String getPowerPlant()

Getter for power plant.

Returns:

the power plant

setPowerPlant

public void setPowerPlant(String powerPlant)

Setter for power plant.

Parameters:

powerPlant - the power plant

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 electricity supply data from the API.

Returns:

a list of the available codes and their values