com.paypal.sdk.models

Class ShippingDetails

java.lang.Object

com.paypal.sdk.models.ShippingDetails

public class ShippingDetails
extends Object

This is a model class for ShippingDetails type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShippingDetails.Builder Class to build instances of ShippingDetails.

Constructor Summary

Constructors

Constructor and Description
ShippingDetails() Default constructor.
ShippingDetails(ShippingName name, String emailAddress, PhoneNumberWithCountryCode phoneNumber, FulfillmentType type, List<ShippingOption> options, Address address) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Address	getAddress() Getter for Address.
String	getEmailAddress() Getter for EmailAddress.
ShippingName	getName() Getter for Name.
List<ShippingOption>	getOptions() Getter for Options.
PhoneNumberWithCountryCode	getPhoneNumber() Getter for PhoneNumber.
FulfillmentType	getType() Getter for Type.
void	setAddress(Address address) Setter for Address.
void	setEmailAddress(String emailAddress) Setter for EmailAddress.
void	setName(ShippingName name) Setter for Name.
void	setOptions(List<ShippingOption> options) Setter for Options.
void	setPhoneNumber(PhoneNumberWithCountryCode phoneNumber) Setter for PhoneNumber.
void	setType(FulfillmentType type) Setter for Type.
ShippingDetails.Builder	toBuilder() Builds a new ShippingDetails.Builder object.
String	toString() Converts this ShippingDetails into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShippingDetails

public ShippingDetails()

Default constructor.

ShippingDetails

public ShippingDetails(ShippingName name,
                       String emailAddress,
                       PhoneNumberWithCountryCode phoneNumber,
                       FulfillmentType type,
                       List<ShippingOption> options,
                       Address address)

Initialization constructor.

Parameters:

name - ShippingName value for name.

emailAddress - String value for emailAddress.

phoneNumber - PhoneNumberWithCountryCode value for phoneNumber.

type - FulfillmentType value for type.

options - List of ShippingOption value for options.

address - Address value for address.

Method Detail

getName

public ShippingName getName()

Getter for Name. The name of the party.

Returns:

Returns the ShippingName

setName

public void setName(ShippingName name)

Setter for Name. The name of the party.

Parameters:

name - Value for ShippingName

getEmailAddress

public String getEmailAddress()

Getter for EmailAddress. The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Returns:

Returns the String

setEmailAddress

public void setEmailAddress(String emailAddress)

Setter for EmailAddress. The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Parameters:

emailAddress - Value for String

getPhoneNumber

public PhoneNumberWithCountryCode getPhoneNumber()

Getter for PhoneNumber. The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

Returns:

Returns the PhoneNumberWithCountryCode

setPhoneNumber

public void setPhoneNumber(PhoneNumberWithCountryCode phoneNumber)

Setter for PhoneNumber. The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

Parameters:

phoneNumber - Value for PhoneNumberWithCountryCode

getType

public FulfillmentType getType()

Getter for Type. A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.

Returns:

Returns the FulfillmentType

setType

public void setType(FulfillmentType type)

Setter for Type. A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.

Parameters:

type - Value for FulfillmentType

getOptions

public List<ShippingOption> getOptions()

Getter for Options. An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Returns:

Returns the List of ShippingOption

setOptions

public void setOptions(List<ShippingOption> options)

Setter for Options. An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Parameters:

options - Value for List of ShippingOption

getAddress

public Address getAddress()

Getter for Address. The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

Returns:

Returns the Address

setAddress

public void setAddress(Address address)

Setter for Address. The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

Parameters:

address - Value for Address

toString

public String toString()

Converts this ShippingDetails into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ShippingDetails.Builder toBuilder()

Builds a new ShippingDetails.Builder object. Creates the instance with the state of the current model.

Returns:

a new ShippingDetails.Builder object