com.atlassian.marketplace.client.api

Enum AddonQuery.TreatPartlyFreeAs

java.lang.Object

java.lang.Enum<AddonQuery.TreatPartlyFreeAs>

com.atlassian.marketplace.client.api.AddonQuery.TreatPartlyFreeAs

All Implemented Interfaces:

EnumWithKey, Serializable, Comparable<AddonQuery.TreatPartlyFreeAs>

Enclosing class:

AddonQuery

public static enum AddonQuery.TreatPartlyFreeAs
extends Enum<AddonQuery.TreatPartlyFreeAs>
implements EnumWithKey

Determines how paid-via-Atlassian add-ons with free tiers, such as those where the vendor has opted into the Cloud free-for-five tier, are treated in queries.

See Also:

AddonQuery.Builder.treatPartlyFreeAs(Option)

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.marketplace.client.api.EnumWithKey

EnumWithKey.Parser<A extends EnumWithKey>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREE Add-ons with free tiers will be effectively treated as free in queries.
PAID Add-ons with free tiers will be effectively treated as paid in queries.

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey() The string key that represents this value in the Marketplace API.
static AddonQuery.TreatPartlyFreeAs	valueOf(String name) Returns the enum constant of this type with the specified name.
static AddonQuery.TreatPartlyFreeAs[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FREE

public static final AddonQuery.TreatPartlyFreeAs FREE

Add-ons with free tiers will be effectively treated as free in queries. An example of when this should be used is when the application has a Cloud free for X number of users and there are less than or equal to X active users.

PAID

public static final AddonQuery.TreatPartlyFreeAs PAID

Add-ons with free tiers will be effectively treated as paid in queries.

Method Detail

values

public static AddonQuery.TreatPartlyFreeAs[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AddonQuery.TreatPartlyFreeAs c : AddonQuery.TreatPartlyFreeAs.values())
    System.out.println(c);

Returns:

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

valueOf

public static AddonQuery.TreatPartlyFreeAs valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Description copied from interface: EnumWithKey

The string key that represents this value in the Marketplace API.

Specified by:

getKey in interface EnumWithKey