com.atlassian.jira.avatar

Class AvatarFormatParams

java.lang.Object

com.atlassian.jira.avatar.AvatarFormatParams

@ExperimentalApi
 @ParametersAreNonnullByDefault
public class AvatarFormatParams
extends Object

Parameters used when requesting to read an avatars data

Since:

v7.0.1

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
RequestedAvatarFormat	getRequestedFormat() Return the requested (preferred) format to use when reading the avatar data
int	hashCode()
boolean	isStrict() Should this request be treated as strict.
static AvatarFormatParams	of(RequestedAvatarFormat requestedFormat) Create a AvatarFormatParams with the requested format, and not strict
AvatarFormatParams	strict() Create a new AvatarFormatParams from the current instance, but with strictness enabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static AvatarFormatParams of(RequestedAvatarFormat requestedFormat)

Create a AvatarFormatParams with the requested format, and not strict

Parameters:

requestedFormat - The requested (preferred) format of the avatar image. Can not be null

Returns:

The equivalent of new AvatarFormatParams(requestedFormat, false

strict

public AvatarFormatParams strict()

Create a new AvatarFormatParams from the current instance, but with strictness enabled

Returns:

A new instance of this, but with strict equal to true

getRequestedFormat

public RequestedAvatarFormat getRequestedFormat()

Return the requested (preferred) format to use when reading the avatar data

Returns:

The format

isStrict

public boolean isStrict()

Should this request be treated as strict. If it is strict, then if it is not possible to support this format, as detailed by RequestedAvatarFormat.isSupportedBy(Avatar), then should fail. Otherwise treat the request as a best-effort attempt, and fall back to using the actual avatars content type, where the actual content type used can be determined by checking RequestedAvatarFormat.getResponseContentType(Avatar).

Returns:

Whether this request is to be treated as strict or not

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object