com.github.dannil.scbjavaclient.model.financialmarkets.shareholders

Class ForeignOwnershipOfShares

java.lang.Object

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

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

com.github.dannil.scbjavaclient.model.financialmarkets.shareholders.ForeignOwnershipOfShares

public class ForeignOwnershipOfShares
extends AbstractTimeAndValueModel<String,Double>

Model for foreign ownership of shares data.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
ForeignOwnershipOfShares() Default constructor.
ForeignOwnershipOfShares(String country, String year, List<ValueNode<Double>> values) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCountry() Getter for country.
static Map<String,Collection<String>>	getInputs() Get the available codes and their respective values for the foreign ownership of shares data from the API.
int	hashCode()
void	setCountry(String country) Setter for country.
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

ForeignOwnershipOfShares

public ForeignOwnershipOfShares()

Default constructor.

ForeignOwnershipOfShares

public ForeignOwnershipOfShares(String country,
                                String year,
                                List<ValueNode<Double>> values)

Overloaded constructor.

Parameters:

country - the country

year - the year

values - the values

Method Detail

getCountry

public String getCountry()

Getter for country.

Returns:

the country

setCountry

public void setCountry(String country)

Setter for country.

Parameters:

country - the country

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTimeAndValueModel<String,Double>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractTimeAndValueModel<String,Double>

toString

public String toString()

Specified by:

toString in class AbstractTimeAndValueModel<String,Double>

getInputs

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

Get the available codes and their respective values for the foreign ownership of shares data from the API.

Returns:

a list of the available codes and their values