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

Class OwnershipOfShares

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.OwnershipOfShares

Direct Known Subclasses:

OwnershipOfSharesByMarketplace, OwnershipOfSharesBySeries

public class OwnershipOfShares
extends AbstractTimeAndValueModel<String,Double>

Model for ownership of shares data.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
OwnershipOfShares() Default constructor.
OwnershipOfShares(String sector, String year, List<ValueNode<Double>> 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 ownership of shares data from the API.
String	getSector() Getter for sector.
int	hashCode()
void	setSector(String sector) Setter for sector.
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

OwnershipOfShares

public OwnershipOfShares()

Default constructor.

OwnershipOfShares

public OwnershipOfShares(String sector,
                         String year,
                         List<ValueNode<Double>> values)

Overloaded constructor.

Parameters:

sector - the sector

year - the year

values - the values

Method Detail

getSector

public String getSector()

Getter for sector.

Returns:

the sector

setSector

public void setSector(String sector)

Setter for sector.

Parameters:

sector - the sector

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 ownership of shares data from the API.

Returns:

a list of the available codes and their values