Package com.github.natche.gravatarjavaclient.enums

Enum Class GravatarRating

java.lang.Object

java.lang.Enum<GravatarRating>

com.github.natche.gravatarjavaclient.enums.GravatarRating

All Implemented Interfaces:

Serializable, Comparable<GravatarRating>, Constable

public enum GravatarRating
extends Enum<GravatarRating>

Valid ratings for a Gravatar Avatar image. Gravatar allows users to self-rate their images so that they can indicate if an image is appropriate for a given audience. By default, only G rated images are displayed unless a user has explicitly chosen they would like to view higher rated images.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
G	The G rating for a Gravatar user image.
PG	The PG rating for a Gravatar user image.
R	The R rating for a Gravatar user image.
X	The X rating for a Gravatar user image.

Method Summary

Modifier and Type	Method	Description
String	getUrlParameter()	Returns the URL parameter for this GravatarRating.
static GravatarRating	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GravatarRating[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

G

public static final GravatarRating G

The G rating for a Gravatar user image. Suitable for display on all websites with any audience type.

PG

public static final GravatarRating PG

The PG rating for a Gravatar user image. May contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence.

R

public static final GravatarRating R

The R rating for a Gravatar user image. May contain such things as harsh profanity, intense violence, nudity, or hard drug use.

X

public static final GravatarRating X

The X rating for a Gravatar user image. May contain hardcore sexual imagery or extremely disturbing violence.

Method Details

values

public static GravatarRating[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GravatarRating valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getUrlParameter

public String getUrlParameter()

Returns the URL parameter for this GravatarRating.

Returns:

the URL parameter for this GravatarRating