yahoofinance

Class Stock

java.lang.Object

yahoofinance.Stock

public class Stock
extends Object

Author:

Stijn Strickx

Constructor Summary

Constructors

Constructor and Description
Stock(String symbol)

Method Summary

Modifier and Type	Method and Description
String	getCurrency() Get the currency of the stock
StockDividend	getDividend() Returns the dividend data available for this stock.
StockDividend	getDividend(boolean refresh) Returns the dividend data available for this stock.
List<HistoricalDividend>	getDividendHistory() This method will return historical dividends from this stock.
List<HistoricalDividend>	getDividendHistory(Calendar from) Requests the historical dividends for this stock with the following characteristics.
List<HistoricalDividend>	getDividendHistory(Calendar from, Calendar to) Requests the historical dividends for this stock with the following characteristics.
List<HistoricalQuote>	getHistory() This method will return historical quotes from this stock.
List<HistoricalQuote>	getHistory(Calendar from) Requests the historical quotes for this stock with the following characteristics.
List<HistoricalQuote>	getHistory(Calendar from, Calendar to) Requests the historical quotes for this stock with the following characteristics.
List<HistoricalQuote>	getHistory(Calendar from, Calendar to, Interval interval) Requests the historical quotes for this stock with the following characteristics.
List<HistoricalQuote>	getHistory(Calendar from, Interval interval) Requests the historical quotes for this stock with the following characteristics.
List<HistoricalQuote>	getHistory(Interval interval) Requests the historical quotes for this stock with the following characteristics.
String	getName() Get the full name of the stock
StockQuote	getQuote() Returns the basic quotes data available for this stock.
StockQuote	getQuote(boolean refresh) Returns the basic quotes data available for this stock.
List<HistoricalSplit>	getSplitHistory() This method will return historical splits from this stock.
List<HistoricalSplit>	getSplitHistory(Calendar from) Requests the historical splits for this stock with the following characteristics.
List<HistoricalSplit>	getSplitHistory(Calendar from, Calendar to) Requests the historical splits for this stock with the following characteristics.
StockStats	getStats() Returns the statistics available for this stock.
StockStats	getStats(boolean refresh) Returns the statistics available for this stock.
String	getStockExchange() Get the exchange on which the stock is traded
String	getSymbol()
boolean	isValid() Checks if the returned name is null.
void	print()
void	setCurrency(String currency)
void	setDividend(StockDividend dividend)
void	setDividendHistory(List<HistoricalDividend> dividendHistory)
void	setHistory(List<HistoricalQuote> history)
void	setName(String name)
void	setQuote(StockQuote quote)
void	setSplitHistory(List<HistoricalSplit> splitHistory)
void	setStats(StockStats stats)
void	setStockExchange(String stockExchange)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Stock

public Stock(String symbol)

Method Detail

isValid

public boolean isValid()

Checks if the returned name is null. This probably means that the symbol was not recognized by Yahoo Finance.

Returns:

whether this stock's symbol is known by Yahoo Finance (true) or not (false)

getQuote

public StockQuote getQuote()

Returns the basic quotes data available for this stock.

Returns:

basic quotes data available for this stock

See Also:

getQuote(boolean)

getQuote

public StockQuote getQuote(boolean refresh)
                    throws IOException

Returns the basic quotes data available for this stock. This method will return null in the following situations:

• the data hasn't been loaded yet in a previous request and refresh is set to false.
• refresh is true and the data cannot be retrieved from Yahoo Finance for whatever reason (symbol not recognized, no network connection, ...)

When the quote data gets refreshed, it will automatically also refresh the statistics and dividend data of the stock from Yahoo Finance in the same request.

Parameters:

refresh - indicates whether the data should be requested again to Yahoo Finance

Returns:

basic quotes data available for this stock

Throws:

IOException - when there's a connection problem

setQuote

public void setQuote(StockQuote quote)

getStats

public StockStats getStats()

Returns the statistics available for this stock.

Returns:

statistics available for this stock

See Also:

getStats(boolean)

getStats

public StockStats getStats(boolean refresh)
                    throws IOException

Returns the statistics available for this stock. This method will return null in the following situations:

• the data hasn't been loaded yet in a previous request and refresh is set to false.
• refresh is true and the data cannot be retrieved from Yahoo Finance for whatever reason (symbol not recognized, no network connection, ...)

When the statistics get refreshed, it will automatically also refresh the quote and dividend data of the stock from Yahoo Finance in the same request.

Parameters:

refresh - indicates whether the data should be requested again to Yahoo Finance

Returns:

statistics available for this stock

Throws:

IOException - when there's a connection problem

setStats

public void setStats(StockStats stats)

getDividend

public StockDividend getDividend()

Returns the dividend data available for this stock.

Returns:

dividend data available for this stock

See Also:

getDividend(boolean)

getDividend

public StockDividend getDividend(boolean refresh)
                          throws IOException

Returns the dividend data available for this stock. This method will return null in the following situations:

• the data hasn't been loaded yet in a previous request and refresh is set to false.
• refresh is true and the data cannot be retrieved from Yahoo Finance for whatever reason (symbol not recognized, no network connection, ...)

When the dividend data get refreshed, it will automatically also refresh the quote and statistics data of the stock from Yahoo Finance in the same request.

Parameters:

refresh - indicates whether the data should be requested again to Yahoo Finance

Returns:

dividend data available for this stock

Throws:

IOException - when there's a connection problem

setDividend

public void setDividend(StockDividend dividend)

getHistory

public List<HistoricalQuote> getHistory()
                                 throws IOException

This method will return historical quotes from this stock. If the historical quotes are not available yet, they will be requested first from Yahoo Finance.

If the historical quotes are not available yet, the following characteristics will be used for the request:

• from: 1 year ago (default)
• to: today (default)
• interval: MONTHLY (default)

There are several more methods available that allow you to define some characteristics of the historical data. Calling one of those methods will result in a new request being sent to Yahoo Finance.

Returns:

a list of historical quotes from this stock

Throws:

IOException - when there's a connection problem

See Also:

getHistory(yahoofinance.histquotes.Interval), getHistory(java.util.Calendar), getHistory(java.util.Calendar, java.util.Calendar), getHistory(java.util.Calendar, yahoofinance.histquotes.Interval), getHistory(java.util.Calendar, java.util.Calendar, yahoofinance.histquotes.Interval)

getHistory

public List<HistoricalQuote> getHistory(Interval interval)
                                 throws IOException

Requests the historical quotes for this stock with the following characteristics.

• from: 1 year ago (default)
• to: today (default)
• interval: specified value

Parameters:

interval - the interval of the historical data

Returns:

a list of historical quotes from this stock

Throws:

IOException - when there's a connection problem

See Also:

getHistory()

getHistory

public List<HistoricalQuote> getHistory(Calendar from)
                                 throws IOException

Requests the historical quotes for this stock with the following characteristics.

• from: specified value
• to: today (default)
• interval: MONTHLY (default)

Parameters:

from - start date of the historical data

Returns:

a list of historical quotes from this stock

Throws:

IOException - when there's a connection problem

See Also:

getHistory()

getHistory

public List<HistoricalQuote> getHistory(Calendar from,
                                        Interval interval)
                                 throws IOException

Requests the historical quotes for this stock with the following characteristics.

• from: specified value
• to: today (default)
• interval: specified value

Parameters:

from - start date of the historical data

interval - the interval of the historical data

Returns:

a list of historical quotes from this stock

Throws:

IOException - when there's a connection problem

See Also:

getHistory()

getHistory

public List<HistoricalQuote> getHistory(Calendar from,
                                        Calendar to)
                                 throws IOException

Requests the historical quotes for this stock with the following characteristics.

• from: specified value
• to: specified value
• interval: MONTHLY (default)

Parameters:

from - start date of the historical data

to - end date of the historical data

Returns:

a list of historical quotes from this stock

Throws:

IOException - when there's a connection problem

See Also:

getHistory()

getHistory

public List<HistoricalQuote> getHistory(Calendar from,
                                        Calendar to,
                                        Interval interval)
                                 throws IOException

Requests the historical quotes for this stock with the following characteristics.

• from: specified value
• to: specified value
• interval: specified value

Parameters:

from - start date of the historical data

to - end date of the historical data

interval - the interval of the historical data

Returns:

a list of historical quotes from this stock

Throws:

IOException - when there's a connection problem

See Also:

getHistory()

setHistory

public void setHistory(List<HistoricalQuote> history)

getDividendHistory

public List<HistoricalDividend> getDividendHistory()
                                            throws IOException

This method will return historical dividends from this stock. If the historical dividends are not available yet, they will be requested first from Yahoo Finance.

If the historical dividends are not available yet, the following characteristics will be used for the request:

• from: 1 year ago (default)
• to: today (default)

There are several more methods available that allow you to define some characteristics of the historical data. Calling one of those methods will result in a new request being sent to Yahoo Finance.

Returns:

a list of historical dividends from this stock

Throws:

IOException - when there's a connection problem

See Also:

getDividendHistory(java.util.Calendar), getDividendHistory(java.util.Calendar, java.util.Calendar)

getDividendHistory

public List<HistoricalDividend> getDividendHistory(Calendar from)
                                            throws IOException

Requests the historical dividends for this stock with the following characteristics.

• from: specified value
• to: today (default)

Parameters:

from - start date of the historical data

Returns:

a list of historical dividends from this stock

Throws:

IOException - when there's a connection problem

See Also:

getDividendHistory()

getDividendHistory

public List<HistoricalDividend> getDividendHistory(Calendar from,
                                                   Calendar to)
                                            throws IOException

Requests the historical dividends for this stock with the following characteristics.

• from: specified value
• to: specified value

Parameters:

from - start date of the historical data

to - end date of the historical data

Returns:

a list of historical dividends from this stock

Throws:

IOException - when there's a connection problem

See Also:

getDividendHistory()

setDividendHistory

public void setDividendHistory(List<HistoricalDividend> dividendHistory)

getSplitHistory

public List<HistoricalSplit> getSplitHistory()
                                      throws IOException

This method will return historical splits from this stock. If the historical splits are not available yet, they will be requested first from Yahoo Finance.

If the historical splits are not available yet, the following characteristics will be used for the request:

• from: 1 year ago (default)
• to: today (default)

There are several more methods available that allow you to define some characteristics of the historical data. Calling one of those methods will result in a new request being sent to Yahoo Finance.

Returns:

a list of historical splits from this stock

Throws:

IOException - when there's a connection problem

See Also:

getSplitHistory(java.util.Calendar), getSplitHistory(java.util.Calendar, java.util.Calendar)

getSplitHistory

public List<HistoricalSplit> getSplitHistory(Calendar from)
                                      throws IOException

Requests the historical splits for this stock with the following characteristics.

• from: specified value
• to: today (default)

Parameters:

from - start date of the historical data

Returns:

a list of historical splits from this stock

Throws:

IOException - when there's a connection problem

See Also:

getSplitHistory()

getSplitHistory

public List<HistoricalSplit> getSplitHistory(Calendar from,
                                             Calendar to)
                                      throws IOException

Requests the historical splits for this stock with the following characteristics.

• from: specified value
• to: specified value

Parameters:

from - start date of the historical data

to - end date of the historical data

Returns:

a list of historical splits from this stock

Throws:

IOException - when there's a connection problem

See Also:

getSplitHistory()

setSplitHistory

public void setSplitHistory(List<HistoricalSplit> splitHistory)

getSymbol

public String getSymbol()

getName

public String getName()

Get the full name of the stock

Returns:

the name or null if the data is not available

setName

public void setName(String name)

getCurrency

public String getCurrency()

Get the currency of the stock

Returns:

the currency or null if the data is not available

setCurrency

public void setCurrency(String currency)

getStockExchange

public String getStockExchange()

Get the exchange on which the stock is traded

Returns:

the exchange or null if the data is not available

setStockExchange

public void setStockExchange(String stockExchange)

toString

public String toString()

Overrides:

toString in class Object

print

public void print()