com.bitpay.sdk.model.rate.Rate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bitpay_sdk Show documentation
Full implementation of the BitPay Payment Gateway. This library implements BitPay's Cryptographically Secure RESTful API.
The newest version!
/*
 * Copyright (c) 2019 BitPay.
 * All rights reserved.
 */

package com.bitpay.sdk.model.rate;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * 
 * Rate is a class that represents a currency name, currency code, and value,
 * and is used to create an object that is used when fetching exchange rates
 * from the API.
 * 
 * 
 * Here's an example of the JSON object that's created:
 * 
 *  * {
 *   "code": "BTC",
 *   "name": "Bitcoin",
 *   "rate": 1
 * }
 * 
 *
 * @see REST API Rates
 * @see com.bitpay.sdk.Client#getRates()
 * @see com.bitpay.sdk.model.rate.Rates
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class Rate {

    /**
     * An ISO 4217 currency code or cryptocurrency code.
     * 
     * Refer to ISO Standards
     * for a list of ISO 4217 currency codes.
     *
     */
    protected String code;

    /**
     * The name of the currency or cryptocurrency.
     * 
     * Refer to ISO Standards
     * for a list of ISO 4217 currency codes.
     */
    protected String name;

    /**
     * The value of the rate, returned in the JSON as "rate" and to a precision
     * of two decimal places.
     */
    protected Double value;

    /**
     * Class constructor.
     */
    public Rate() {
    }

    /**
     * Returns the name of the rate's currency or cryptocurrency.
     *
     * @return the name of the rate's currency or cryptocurrency
     */
    @JsonIgnore
    public String getName() {
        return this.name;
    }

    /**
     * Sets the name of the rate's currency or cryptocurrency.
     *
     * @param name the name of the rate
     */
    @JsonProperty("name")
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Returns the rate's ISO 4217 currency code or cryptocurrency code.
     *
     * @return the rate's ISO 4217 currency code or cryptocurrency code
     */
    @JsonIgnore
    public String getCode() {
        return this.code;
    }

    /**
     * Sets the rate's ISO 4217 currency code or cryptocurrency code.
     *
     * @param code the rate's ISO 4217 currency code or cryptocurrency code
     */
    @JsonProperty("code")
    public void setCode(String code) {
        this.code = code;
    }

    /**
     * Returns the numeric value of the rate.
     *
     * @return the numeric value of the rate, to two decimal places
     */
    @JsonIgnore
    public Double getValue() {
        return this.value;
    }

    /**
     * Sets the numeric value of the rate.
     *
     * @param value the numeric value of the rate, to two decimal places
     */
    @JsonProperty("rate")
    public void setValue(Double value) {
        this.value = value;
    }

}