StarRating
public final class StarRating implements Rating
A class for rating expressed as the number of stars.
Summary
Public constructors |
|---|
StarRating(@IntRange(from = 1) int maxStars)Creates a unrated StarRating instance with |
StarRating(@IntRange(from = 1) int maxStars, float starRating)Creates a StarRating instance with |
Public methods |
|
|---|---|
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
public StarRating(@IntRange(from = 1) int maxStars)
Creates a unrated StarRating instance with maxStars. If maxStars is not a positive integer, it will throw IllegalArgumentException.
| Parameters | |
|---|---|
@IntRange(from = 1) int maxStars |
a range of this star rating from 0.0f to |
public StarRating(@IntRange(from = 1) int maxStars, float starRating)
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.
| Parameters | |
|---|---|
@IntRange(from = 1) int maxStars |
the maximum number of stars which this rating can have. |
float starRating |
a number ranging from 0.0f to |
Public methods
public int getMaxStars()
Returns the max stars.
| Returns | |
|---|---|
int |
a max number of stars for this star rating. |
public float getStarRating()
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. |
public boolean isRated()
Returns whether there is a rating value available.
| Returns | |
|---|---|
boolean |
|