All Implemented Interfaces:
```
public final class ReadingTime

                    
```
Calculates the reading time of the given text.
Based on Medium's calculation.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`ReadingTime.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`text`
`private Integer`	`wpm`
`private Boolean`	`excludeImages`
`private Integer`	`extra`
`private String`	`postfix`
`private String`	`plural`
`private RoundingMode`	`roundingMode`

Constructor Summary

Constructors
Constructor	Description
`ReadingTime(String text, Integer wpm, String postfix, String plural, Boolean excludeImages, Integer extra, RoundingMode roundingMode)`	Constructs a new ReadingTime object.
`ReadingTime(String text, Integer wpm, String postfix, String plural, Boolean excludeImages, Integer extra)`	Constructs a new ReadingTime object.
`ReadingTime(String text, Integer wpm, String postfix, String plural, Boolean excludeImages)`	Constructs a new ReadingTime object.
`ReadingTime(String text, Integer wpm, String postfix, String plural)`	Constructs a new ReadingTime object.
`ReadingTime(String text, Integer wpm, String postfix)`	Constructs a new ReadingTime object.
`ReadingTime(String text, Integer wpm)`	Constructs a new ReadingTime object.
`ReadingTime(String text)`	Constructs a new ReadingTime object.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getText()`
`final Unit`	`setText(String text)`
`final Integer`	`getWpm()`
`final Unit`	`setWpm(Integer wpm)`
`final Boolean`	`getExcludeImages()`
`final Unit`	`setExcludeImages(Boolean excludeImages)`
`final Integer`	`getExtra()`
`final Unit`	`setExtra(Integer extra)`
`final String`	`getPostfix()`
`final Unit`	`setPostfix(String postfix)`
`final String`	`getPlural()`
`final Unit`	`setPlural(String plural)`
`final RoundingMode`	`getRoundingMode()`
`final Unit`	`setRoundingMode(RoundingMode roundingMode)`
`final Double`	`calcReadingTimeInSec()`	Calculates and returns the reading time in seconds.
`final String`	`calcReadingTime()`	Calculates and returns the reading time.

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

- Constructor Detail
  - ReadingTime
```
ReadingTime(String text, Integer wpm, String postfix, String plural, Boolean excludeImages, Integer extra, RoundingMode roundingMode)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
    
    wpm - The words per minute reading average.
    
    postfix - The value to be appended to the reading time.
    
    plural - The value to be appended if the reading time is more than 1 minute.
    
    excludeImages - Images are excluded from the reading time when set.
    
    extra - Additional seconds to be added to the total reading time.
    
    roundingMode - The RoundingMode to apply.
  - ReadingTime
```
ReadingTime(String text, Integer wpm, String postfix, String plural, Boolean excludeImages, Integer extra)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
    
    wpm - The words per minute reading average.
    
    postfix - The value to be appended to the reading time.
    
    plural - The value to be appended if the reading time is more than 1 minute.
    
    excludeImages - Images are excluded from the reading time when set.
    
    extra - Additional seconds to be added to the total reading time.
  - ReadingTime
```
ReadingTime(String text, Integer wpm, String postfix, String plural, Boolean excludeImages)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
    
    wpm - The words per minute reading average.
    
    postfix - The value to be appended to the reading time.
    
    plural - The value to be appended if the reading time is more than 1 minute.
    
    excludeImages - Images are excluded from the reading time when set.
  - ReadingTime
```
ReadingTime(String text, Integer wpm, String postfix, String plural)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
    
    wpm - The words per minute reading average.
    
    postfix - The value to be appended to the reading time.
    
    plural - The value to be appended if the reading time is more than 1 minute.
  - ReadingTime
```
ReadingTime(String text, Integer wpm, String postfix)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
    
    wpm - The words per minute reading average.
    
    postfix - The value to be appended to the reading time.
  - ReadingTime
```
ReadingTime(String text, Integer wpm)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
    
    wpm - The words per minute reading average.
  - ReadingTime
```
ReadingTime(String text)
```
    Constructs a new ReadingTime object.
    
    Parameters:
    
    text - The text to be evaluated.
- Method Detail
  - getText
```
 final String getText()
```
  - setText
```
 final Unit setText(String text)
```
  - getWpm
```
 final Integer getWpm()
```
  - setWpm
```
 final Unit setWpm(Integer wpm)
```
  - getExcludeImages
```
 final Boolean getExcludeImages()
```
  - setExcludeImages
```
 final Unit setExcludeImages(Boolean excludeImages)
```
  - getExtra
```
 final Integer getExtra()
```
  - setExtra
```
 final Unit setExtra(Integer extra)
```
  - getPostfix
```
 final String getPostfix()
```
  - setPostfix
```
 final Unit setPostfix(String postfix)
```
    Parameters:
    
    postfix - The value to be appended to the reading time.
  - getPlural
```
 final String getPlural()
```
  - setPlural
```
 final Unit setPlural(String plural)
```
    Parameters:
    
    plural - The value to be appended if the reading time is more than 1 minute.
  - getRoundingMode
```
 final RoundingMode getRoundingMode()
```
  - setRoundingMode
```
 final Unit setRoundingMode(RoundingMode roundingMode)
```
    Parameters:
    
    roundingMode - The RoundingMode to apply.
  - calcReadingTimeInSec
```
 final Double calcReadingTimeInSec()
```
    Calculates and returns the reading time in seconds.
    ((word count / wpm) * 60) + images + extra
  - calcReadingTime
```
 final String calcReadingTime()
```
    Calculates and returns the reading time. (eg. 1 min read)
    (reading time in sec / 60) + postfix

Class ReadingTime

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReadingTime

ReadingTime

ReadingTime

ReadingTime

ReadingTime

ReadingTime

ReadingTime

Method Detail

getText

setText

getWpm

setWpm

getExcludeImages

setExcludeImages

getExtra

setExtra

getPostfix

setPostfix

getPlural

setPlural

getRoundingMode

setRoundingMode

calcReadingTimeInSec

calcReadingTime