Package com.github.natche.gravatarjavaclient.enums

Enum Class GravatarQrImageType

java.lang.Object

java.lang.Enum<GravatarQrImageType>

com.github.natche.gravatarjavaclient.enums.GravatarQrImageType

All Implemented Interfaces:

Serializable, Comparable<GravatarQrImageType>, Constable

public enum GravatarQrImageType
extends Enum<GravatarQrImageType>

The types of QR images returned by the Gravatar API. Types, within the scope of Gravatar, are indicative of the image in the center of the QR code.

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
Blank	No logo or avatar in the center.
Default	Same as Blank.
Gravatar	The Gravatar logo in the center.
User	The user's avatar in the center.

Method Summary

Modifier and Type	Method	Description
String	getAsUrlParameter(boolean isFirst)	Returns the URL parameter for this image type.
static GravatarQrImageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GravatarQrImageType[]	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

Blank

public static final GravatarQrImageType Blank

No logo or avatar in the center.

Default

public static final GravatarQrImageType Default

Same as Blank.

User

public static final GravatarQrImageType User

The user's avatar in the center.

Gravatar

public static final GravatarQrImageType Gravatar

The Gravatar logo in the center.

Method Details

values

public static GravatarQrImageType[] 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 GravatarQrImageType 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

getAsUrlParameter

public String getAsUrlParameter(boolean isFirst)

Returns the URL parameter for this image type.

Parameters:

isFirst - whether this is the first url parameter

Returns:

the URL parameter for this image type