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

Class OwnershipOfSharesBySeries

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

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

public class OwnershipOfSharesBySeries
extends OwnershipOfShares

Model for ownership of shares by series data.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
OwnershipOfSharesBySeries() Default constructor.
OwnershipOfSharesBySeries(String sector, String shareClass, 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 by series data from the API.
String	getShareClass() Getter for share class.
int	hashCode()
void	setShareClass(String shareClass) Setter for share class.
String	toString()

Methods inherited from class com.github.dannil.scbjavaclient.model.financialmarkets.shareholders.OwnershipOfShares

getSector, setSector

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

OwnershipOfSharesBySeries

public OwnershipOfSharesBySeries()

Default constructor.

OwnershipOfSharesBySeries

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

Overloaded constructor.

Parameters:

sector - the sector

shareClass - the share class

year - the year

values - the values

Method Detail

getShareClass

public String getShareClass()

Getter for share class.

Returns:

the share class

setShareClass

public void setShareClass(String shareClass)

Setter for share class.

Parameters:

shareClass - the share class

hashCode

public int hashCode()

Overrides:

hashCode in class OwnershipOfShares

equals

public boolean equals(Object obj)

Overrides:

equals in class OwnershipOfShares

toString

public String toString()

Overrides:

toString in class OwnershipOfShares

getInputs

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

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

Returns:

a list of the available codes and their values