com.paypal.sdk.models

Enum ShippingPreference

java.lang.Object

java.lang.Enum<ShippingPreference>

com.paypal.sdk.models.ShippingPreference

All Implemented Interfaces:

Serializable, Comparable<ShippingPreference>

public enum ShippingPreference
extends Enum<ShippingPreference>

ShippingPreference to be used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
_UNKNOWN Unknown values will be mapped by this enum member
GET_FROM_FILE Get the customer-provided shipping address on the PayPal site.
NO_SHIPPING Redacts the shipping address from the PayPal site.
SET_PROVIDED_ADDRESS Get the merchant-provided address.

Method Summary

Modifier and Type	Method and Description
static ShippingPreference	constructFromString(String toConvert) Returns the enum member associated with the given string value.
static ShippingPreference	fromString(String toConvert) Returns the enum member associated with the given string value.
String	toString() Get string representation of this enum.
static List<String>	toValue(List<ShippingPreference> toConvert) Convert list of ShippingPreference values to list of string values.
String	value() Returns the string value associated with the enum member.
static ShippingPreference	valueOf(String name) Returns the enum constant of this type with the specified name.
static ShippingPreference[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GET_FROM_FILE

public static final ShippingPreference GET_FROM_FILE

Get the customer-provided shipping address on the PayPal site.

NO_SHIPPING

public static final ShippingPreference NO_SHIPPING

Redacts the shipping address from the PayPal site. Recommended for digital goods.

SET_PROVIDED_ADDRESS

public static final ShippingPreference SET_PROVIDED_ADDRESS

Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.

_UNKNOWN

public static final ShippingPreference _UNKNOWN

Unknown values will be mapped by this enum member

Method Detail

values

public static ShippingPreference[] 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 (ShippingPreference c : ShippingPreference.values())
    System.out.println(c);

Returns:

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

valueOf

public static ShippingPreference 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

constructFromString

public static ShippingPreference constructFromString(String toConvert)
                                              throws IOException

Returns the enum member associated with the given string value.

Parameters:

toConvert - String value to get enum member.

Returns:

The enum member against the given string value.

Throws:

IOException - when provided value is not mapped to any enum member.

fromString

public static ShippingPreference fromString(String toConvert)

Returns the enum member associated with the given string value.

Parameters:

toConvert - String value to get enum member.

Returns:

The enum member against the given string value.

value

public String value()

Returns the string value associated with the enum member.

Returns:

The string value against enum member.

toString

public String toString()

Get string representation of this enum.

Overrides:

toString in class Enum<ShippingPreference>

toValue

public static List<String> toValue(List<ShippingPreference> toConvert)

Convert list of ShippingPreference values to list of string values.

Parameters:

toConvert - The list of ShippingPreference values to convert.

Returns:

List of representative string values.