yahoofinance.histquotes2.HistoricalSplit 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.histquotes2;

import java.math.BigDecimal;
import java.math.RoundingMode;
import java.text.SimpleDateFormat;
import java.util.Calendar;

/**
 * All getters can return null in case the data is not available from Yahoo Finance.
 * 
 * @author Randle McMurphy
 */
public class HistoricalSplit {
	
    private String symbol;
    
    private Calendar date;
    
    private BigDecimal numerator;
    private BigDecimal denominator;
    
    public HistoricalSplit() {}

    public HistoricalSplit(String symbol, Calendar date, BigDecimal numerator, BigDecimal denominator) {
        this.symbol = symbol;
        this.date = date;
        this.numerator = numerator;
        this.denominator = denominator;
    }

    public String getSymbol() {
        return symbol;
    }

    public void setSymbol(String symbol) {
        this.symbol = symbol;
    }
    
    public Calendar getDate() {
        return date;
    }

    public void setDate(Calendar date) {
        this.date = date;
    }

    public BigDecimal getNumerator() {
        return numerator;
    }

    public void setNumerator(BigDecimal numerator) {
        this.numerator = numerator;
    }

    public BigDecimal getDenominator() {
        return denominator;
    }

    public void setDenominator(BigDecimal denominator) {
        this.denominator = denominator;
    }

    /**
     * 
     * @return      a calculated split factor value which is equal to numerator divided by denominator
     */
    public BigDecimal getSplitFactor() {
        return numerator.divide(denominator, 10, RoundingMode.HALF_UP);  
    }

    @Override
    public String toString() {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        String dateStr = dateFormat.format(this.date.getTime());
        return "SPLIT: " + this.symbol + "@" + dateStr + ": " + this.numerator + " / " + this.denominator;
    }

}