yahoofinance.quotes.fx.FxQuote Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of YahooFinanceAPI Show documentation

This library provides some methods that should make it easy to communicate with the Yahoo Finance API. It allows you to request detailed information, some statistics and historical quotes on stocks. Separate functionality is available to request a simple FX quote. Please check the javadoc to get a complete overview of the available methods and to get an idea of which data is available from Yahoo Finance.

There is a newer version: 3.17.0

Show newest version


package yahoofinance.quotes.fx;

import yahoofinance.quotes.csv.FxQuotesRequest;

import java.io.IOException;
import java.math.BigDecimal;

/**
 *
 * @author Stijn Strickx
 */
public class FxQuote {
    
    private String symbol;
    private BigDecimal price;
    
    public FxQuote(String symbol) {
        this.symbol = symbol;
        this.price = BigDecimal.ZERO;
    }
    
    public FxQuote(String symbol, BigDecimal price) {
        this.symbol = symbol;
        this.price = price;
    }

    public String getSymbol() {
        return symbol;
    }

    public void setSymbol(String symbol) {
        this.symbol = symbol;
    }

    /**
     * Returns the requested FX rate.
     * 
     * @return  the requested FX rate
     */
    public BigDecimal getPrice() {
        return price;
    }
    
    /**
     * Returns the requested FX rate.
     * This method will return 0 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, ...)
     * 
     * 
     * @param refresh   indicates whether the data should be requested again to Yahoo Finance
     * @return          the requested FX rate
     * @throws java.io.IOException when there's a connection problem
     */
    public BigDecimal getPrice(boolean refresh) throws IOException {
        if(refresh) {
            FxQuotesRequest request = new FxQuotesRequest(this.symbol);
            this.price = request.getSingleResult().getPrice();
        }
        return price;
    }

    public void setPrice(BigDecimal price) {
        this.price = price;
    }
    
    @Override
    public String toString() {
        return this.symbol + ": " + this.price;
    }
    
}