StockDividend (alpaca-java 5.0.0 API)

java.lang.Object
- io.github.mainstringargs.domain.polygon.stockdividends.StockDividend

All Implemented Interfaces:

java.io.Serializable
```
public class StockDividend
extends java.lang.Object
implements java.io.Serializable
```
See: https://polygon.io/docs/#!/Reference/get_v2_reference_dividends_symbol

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`StockDividend()` No args constructor for use in serialization
`StockDividend(java.lang.String symbol, java.lang.String type, java.lang.String exDate, java.time.ZonedDateTime paymentDate, java.time.ZonedDateTime recordDate, java.time.ZonedDateTime declaredDate, java.lang.Double amount, java.lang.String qualified, java.lang.String flag)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`java.lang.Double`	`getAmount()` Amount of the dividend
`java.time.ZonedDateTime`	`getDeclaredDate()` Declared date of the trade
`java.lang.String`	`getExDate()` Execution date of the trade
`java.lang.String`	`getFlag()` Refers to the dividend flag, if set FI = Final dividend, div ends or instrument ends LI = Liquidation, instrument liquidates PR = Proceeds of a sale of rights or shares RE = Redemption of rights AC = Accrued dividend AR = Payment in arrears AD = Additional payment EX = Extra payment SP = Special dividend YE = Year end UR = Unknown rate SU = Regular dividend is suspended
`java.time.ZonedDateTime`	`getPaymentDate()` Payment date of the trade
`java.lang.String`	`getQualified()` Refers to the dividend income type - P = Partially qualified income - Q = Qualified income - N = Unqualified income - null = N/A or unknown Can be P, Q, N or null
`java.time.ZonedDateTime`	`getRecordDate()` Record date of the trade
`java.lang.String`	`getSymbol()` symbol
`java.lang.String`	`getType()` Refers to the dividend payment type - Dividend income - Interest income - Stock dividend - Short term capital gain - Medium term capital gain - Long term capital gain - Unspecified term capital gain
`int`	`hashCode()`
`void`	`setAmount(java.lang.Double amount)` Amount of the dividend
`void`	`setDeclaredDate(java.time.ZonedDateTime declaredDate)` Declared date of the trade
`void`	`setExDate(java.lang.String exDate)` Execution date of the trade
`void`	`setFlag(java.lang.String flag)` Refers to the dividend flag, if set FI = Final dividend, div ends or instrument ends LI = Liquidation, instrument liquidates PR = Proceeds of a sale of rights or shares RE = Redemption of rights AC = Accrued dividend AR = Payment in arrears AD = Additional payment EX = Extra payment SP = Special dividend YE = Year end UR = Unknown rate SU = Regular dividend is suspended
`void`	`setPaymentDate(java.time.ZonedDateTime paymentDate)` Payment date of the trade
`void`	`setQualified(java.lang.String qualified)` Refers to the dividend income type - P = Partially qualified income - Q = Qualified income - N = Unqualified income - null = N/A or unknown Can be P, Q, N or null
`void`	`setRecordDate(java.time.ZonedDateTime recordDate)` Record date of the trade
`void`	`setSymbol(java.lang.String symbol)` symbol
`void`	`setType(java.lang.String type)` Refers to the dividend payment type - Dividend income - Interest income - Stock dividend - Short term capital gain - Medium term capital gain - Long term capital gain - Unspecified term capital gain
`java.lang.String`	`toString()`

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

- Constructor Detail
  - StockDividend
```
public StockDividend()
```
    No args constructor for use in serialization
  - StockDividend
```
public StockDividend(java.lang.String symbol,
                     java.lang.String type,
                     java.lang.String exDate,
                     java.time.ZonedDateTime paymentDate,
                     java.time.ZonedDateTime recordDate,
                     java.time.ZonedDateTime declaredDate,
                     java.lang.Double amount,
                     java.lang.String qualified,
                     java.lang.String flag)
```
    Parameters:
    
    declaredDate -
    
    symbol -
    
    qualified -
    
    amount -
    
    flag -
    
    exDate -
    
    recordDate -
    
    type -
    
    paymentDate -
- Method Detail
  - getSymbol
```
public java.lang.String getSymbol()
```
    symbol
  - setSymbol
```
public void setSymbol(java.lang.String symbol)
```
    symbol
  - getType
```
public java.lang.String getType()
```
    Refers to the dividend payment type
    - Dividend income
    - Interest income
    - Stock dividend
    - Short term capital gain
    - Medium term capital gain
    - Long term capital gain
    - Unspecified term capital gain
  - setType
```
public void setType(java.lang.String type)
```
    Refers to the dividend payment type
    - Dividend income
    - Interest income
    - Stock dividend
    - Short term capital gain
    - Medium term capital gain
    - Long term capital gain
    - Unspecified term capital gain
  - getExDate
```
public java.lang.String getExDate()
```
    Execution date of the trade
  - setExDate
```
public void setExDate(java.lang.String exDate)
```
    Execution date of the trade
  - getPaymentDate
```
public java.time.ZonedDateTime getPaymentDate()
```
    Payment date of the trade
  - setPaymentDate
```
public void setPaymentDate(java.time.ZonedDateTime paymentDate)
```
    Payment date of the trade
  - getRecordDate
```
public java.time.ZonedDateTime getRecordDate()
```
    Record date of the trade
  - setRecordDate
```
public void setRecordDate(java.time.ZonedDateTime recordDate)
```
    Record date of the trade
  - getDeclaredDate
```
public java.time.ZonedDateTime getDeclaredDate()
```
    Declared date of the trade
  - setDeclaredDate
```
public void setDeclaredDate(java.time.ZonedDateTime declaredDate)
```
    Declared date of the trade
  - getAmount
```
public java.lang.Double getAmount()
```
    Amount of the dividend
  - setAmount
```
public void setAmount(java.lang.Double amount)
```
    Amount of the dividend
  - getQualified
```
public java.lang.String getQualified()
```
    Refers to the dividend income type
    - P = Partially qualified income
    - Q = Qualified income
    - N = Unqualified income
    - null = N/A or unknown
    Can be P, Q, N or null
  - setQualified
```
public void setQualified(java.lang.String qualified)
```
    Refers to the dividend income type
    - P = Partially qualified income
    - Q = Qualified income
    - N = Unqualified income
    - null = N/A or unknown
    Can be P, Q, N or null
  - getFlag
```
public java.lang.String getFlag()
```
    Refers to the dividend flag, if set
    FI = Final dividend, div ends or instrument ends
    LI = Liquidation, instrument liquidates
    PR = Proceeds of a sale of rights or shares
    RE = Redemption of rights
    AC = Accrued dividend
    AR = Payment in arrears
    AD = Additional payment
    EX = Extra payment
    SP = Special dividend
    YE = Year end
    UR = Unknown rate
    SU = Regular dividend is suspended
  - setFlag
```
public void setFlag(java.lang.String flag)
```
    Refers to the dividend flag, if set
    FI = Final dividend, div ends or instrument ends
    LI = Liquidation, instrument liquidates
    PR = Proceeds of a sale of rights or shares
    RE = Redemption of rights
    AC = Accrued dividend
    AR = Payment in arrears
    AD = Additional payment
    EX = Extra payment
    SP = Special dividend
    YE = Year end
    UR = Unknown rate
    SU = Regular dividend is suspended
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object

Class StockDividend

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StockDividend

StockDividend

Method Detail

getSymbol

setSymbol

getType

setType

getExDate

setExDate

getPaymentDate

setPaymentDate

getRecordDate

setRecordDate

getDeclaredDate

setDeclaredDate

getAmount

setAmount

getQualified

setQualified

getFlag

setFlag

toString

hashCode

equals