StarRating
class StarRating : Rating
A class for rating expressed as the number of stars.
Summary
Public constructors |
|---|
StarRating(maxStars: @IntRange(from = 1) Int)Creates a unrated StarRating instance with |
StarRating(maxStars: @IntRange(from = 1) Int, starRating: Float)Creates a StarRating instance with |
Public functions |
|
|---|---|
Boolean |
|
Int |
Returns the max stars. |
Float |
Returns the star-based rating value. |
Int |
hashCode() |
Boolean |
isRated()Returns whether there is a rating value available. |
String! |
toString() |
Public constructors
StarRating(maxStars: @IntRange(from = 1) Int)
Creates a unrated StarRating instance with maxStars. If maxStars is not a positive integer, it will throw IllegalArgumentException.
StarRating(maxStars: @IntRange(from = 1) Int, starRating: Float)
Creates a StarRating instance with maxStars and the given integer or fractional number of stars. Non integer values can for instance be used to represent an average rating value, which might not be an integer number of stars. If maxStars is not a positive integer or starRating has invalid value, it will throw IllegalArgumentException.
Public functions
fun getMaxStars(): Int
Returns the max stars.
| Returns | |
|---|---|
Int |
a max number of stars for this star rating. |
fun getStarRating(): Float
Returns the star-based rating value.
| Returns | |
|---|---|
Float |
a rating value greater or equal to 0.0f, or a negative value if it is unrated. |