All Implemented Interfaces:


public final class StockRetrieveDividendsResponse

Information about a dividend announcement for a Stock.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`StockRetrieveDividendsResponse.Builder`	A builder for StockRetrieveDividendsResponse.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<Double>`	`cashAmount()`	Cash amount of the dividend per share owned.
`final Optional<String>`	`currency()`	Currency in which the dividend is paid.
`final Optional<String>`	`dividendType()`	Type of dividend.
`final Optional<LocalDate>`	`exDividendDate()`	Date on or after which a `Stock` is traded without the right to receive the next dividend payment.
`final Optional<LocalDate>`	`payDate()`	Date on which the dividend is paid out.
`final Optional<LocalDate>`	`recordDate()`	Date that the shares must be held to receive the dividend; set by the company.
`final Optional<String>`	`ticker()`	Ticker symbol of the `Stock`.
`final JsonField<Double>`	`_cashAmount()`	Returns the raw JSON value of cashAmount.
`final JsonField<String>`	`_currency()`	Returns the raw JSON value of currency.
`final JsonField<String>`	`_dividendType()`	Returns the raw JSON value of dividendType.
`final JsonField<LocalDate>`	`_exDividendDate()`	Returns the raw JSON value of exDividendDate.
`final JsonField<LocalDate>`	`_payDate()`	Returns the raw JSON value of payDate.
`final JsonField<LocalDate>`	`_recordDate()`	Returns the raw JSON value of recordDate.
`final JsonField<String>`	`_ticker()`	Returns the raw JSON value of ticker.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final StockRetrieveDividendsResponse.Builder`	`toBuilder()`
`final StockRetrieveDividendsResponse`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static StockRetrieveDividendsResponse.Builder`	`builder()`	Returns a mutable builder for constructing an instance of StockRetrieveDividendsResponse.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - cashAmount
```
 final Optional<Double> cashAmount()
```
    Cash amount of the dividend per share owned.
  - currency
```
 final Optional<String> currency()
```
    Currency in which the dividend is paid.
  - dividendType
```
 final Optional<String> dividendType()
```
    Type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.
  - exDividendDate
```
 final Optional<LocalDate> exDividendDate()
```
    Date on or after which a Stock is traded without the right to receive the next dividend payment. If you purchase a Stock on or after the ex-dividend date, you will not receive the upcoming dividend. In ISO 8601 format, YYYY-MM-DD.
  - payDate
```
 final Optional<LocalDate> payDate()
```
    Date on which the dividend is paid out. In ISO 8601 format, YYYY-MM-DD.
  - recordDate
```
 final Optional<LocalDate> recordDate()
```
    Date that the shares must be held to receive the dividend; set by the company. In ISO 8601 format, YYYY-MM-DD.
  - ticker
```
 final Optional<String> ticker()
```
    Ticker symbol of the Stock.
  - _cashAmount
```
 final JsonField<Double> _cashAmount()
```
    Returns the raw JSON value of cashAmount.
    Unlike cashAmount, this method doesn't throw if the JSON field has an unexpected type.
  - _currency
```
 final JsonField<String> _currency()
```
    Returns the raw JSON value of currency.
    Unlike currency, this method doesn't throw if the JSON field has an unexpected type.
  - _dividendType
```
 final JsonField<String> _dividendType()
```
    Returns the raw JSON value of dividendType.
    Unlike dividendType, this method doesn't throw if the JSON field has an unexpected type.
  - _exDividendDate
```
 final JsonField<LocalDate> _exDividendDate()
```
    Returns the raw JSON value of exDividendDate.
    Unlike exDividendDate, this method doesn't throw if the JSON field has an unexpected type.
  - _payDate
```
 final JsonField<LocalDate> _payDate()
```
    Returns the raw JSON value of payDate.
    Unlike payDate, this method doesn't throw if the JSON field has an unexpected type.
  - _recordDate
```
 final JsonField<LocalDate> _recordDate()
```
    Returns the raw JSON value of recordDate.
    Unlike recordDate, this method doesn't throw if the JSON field has an unexpected type.
  - _ticker
```
 final JsonField<String> _ticker()
```
    Returns the raw JSON value of ticker.
    Unlike ticker, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final StockRetrieveDividendsResponse.Builder toBuilder()
```
  - validate
```
 final StockRetrieveDividendsResponse validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static StockRetrieveDividendsResponse.Builder builder()
```
    Returns a mutable builder for constructing an instance of StockRetrieveDividendsResponse.

Class StockRetrieveDividendsResponse

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

cashAmount

currency

dividendType

exDividendDate

payDate

recordDate

ticker

_cashAmount

_currency

_dividendType

_exDividendDate

_payDate

_recordDate

_ticker

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder