PostalAddress

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Comparable, com.aspose.ms.System.IEquatable

public class PostalAddress implements Comparable<PostalAddress>, System.IEquatable<PostalAddress>

Represents a postal address.

Constructors

Constructor Description
PostalAddress()

Methods

Method Description
getPrefered() Gets or sets a value which defines whether postal address is preferred.
setPrefered(boolean value) Gets or sets a value which defines whether postal address is preferred.
getCategory() Gets or sets an object category
setCategory(PostalAddressCategory value) Gets or sets an object category
isMailingAddress() Gets or sets a value which defines whether address may be used for mailing.
setMailingAddress(boolean value) Gets or sets a value which defines whether address may be used for mailing.
getStreet() Gets or sets a street
setStreet(String value) Gets or sets a street
getCity() Gets or sets a city
setCity(String value) Gets or sets a city
getAddress() Gets or sets an address
setAddress(String value) Gets or sets an address
getCountryCode() Gets or sets a country code
setCountryCode(String value) Gets or sets a country code
getPostOfficeBox() Gets or sets a post Office box
setPostOfficeBox(String value) Gets or sets a post Office box
getCountry() Gets or sets a country
setCountry(String value) Gets or sets a country
getPostalCode() Gets or sets a post code
setPostalCode(String value) Gets or sets a post code
getStateOrProvince() Gets or sets a region
setStateOrProvince(String value) Gets or sets a region
toString() Returns a string that represents the current object.
hashCode() GetHashCode returns a hash function for this object.
hashCode(PostalAddress obj) GetHashCode returns a hash function for specified object.
equals(PostalAddress obj)
equals(Object obj) Determines whether the specified Object is equal to the current Object.
equals(PostalAddress x, PostalAddress y) Determines whether the specified object instances are considered equal.
op_Equality(PostalAddress a, PostalAddress b) Determines whether the specified objects are equal.
op_Inequality(PostalAddress a, PostalAddress b) Determines whether the specified objects are not equal.
compareTo(PostalAddress obj) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

PostalAddress()

public PostalAddress()

getPrefered()

public final boolean getPrefered()

Gets or sets a value which defines whether postal address is preferred.

Returns: boolean

setPrefered(boolean value)

public final void setPrefered(boolean value)

Gets or sets a value which defines whether postal address is preferred.

Parameters:

Parameter Type Description
value boolean

getCategory()

public final PostalAddressCategory getCategory()

Gets or sets an object category

Returns: PostalAddressCategory

setCategory(PostalAddressCategory value)

public final void setCategory(PostalAddressCategory value)

Gets or sets an object category

Parameters:

Parameter Type Description
value PostalAddressCategory

isMailingAddress()

public final boolean isMailingAddress()

Gets or sets a value which defines whether address may be used for mailing.

Returns: boolean

setMailingAddress(boolean value)

public final void setMailingAddress(boolean value)

Gets or sets a value which defines whether address may be used for mailing.

Parameters:

Parameter Type Description
value boolean

getStreet()

public final String getStreet()

Gets or sets a street

Returns: java.lang.String

setStreet(String value)

public final void setStreet(String value)

Gets or sets a street

Parameters:

Parameter Type Description
value java.lang.String

getCity()

public final String getCity()

Gets or sets a city

Returns: java.lang.String

setCity(String value)

public final void setCity(String value)

Gets or sets a city

Parameters:

Parameter Type Description
value java.lang.String

getAddress()

public final String getAddress()

Gets or sets an address

Returns: java.lang.String

setAddress(String value)

public final void setAddress(String value)

Gets or sets an address

Parameters:

Parameter Type Description
value java.lang.String

getCountryCode()

public final String getCountryCode()

Gets or sets a country code

Returns: java.lang.String

setCountryCode(String value)

public final void setCountryCode(String value)

Gets or sets a country code

Parameters:

Parameter Type Description
value java.lang.String

getPostOfficeBox()

public final String getPostOfficeBox()

Gets or sets a post Office box

Returns: java.lang.String

setPostOfficeBox(String value)

public final void setPostOfficeBox(String value)

Gets or sets a post Office box

Parameters:

Parameter Type Description
value java.lang.String

getCountry()

public final String getCountry()

Gets or sets a country

Returns: java.lang.String

setCountry(String value)

public final void setCountry(String value)

Gets or sets a country

Parameters:

Parameter Type Description
value java.lang.String

getPostalCode()

public final String getPostalCode()

Gets or sets a post code

Returns: java.lang.String

setPostalCode(String value)

public final void setPostalCode(String value)

Gets or sets a post code

Parameters:

Parameter Type Description
value java.lang.String

getStateOrProvince()

public final String getStateOrProvince()

Gets or sets a region

Returns: java.lang.String

setStateOrProvince(String value)

public final void setStateOrProvince(String value)

Gets or sets a region

Parameters:

Parameter Type Description
value java.lang.String

toString()

public String toString()

Returns a string that represents the current object.

Returns: java.lang.String - Returns a string that represents the current object.

hashCode()

public int hashCode()

GetHashCode returns a hash function for this object.

Returns: int - Returns a hash function for this object.

hashCode(PostalAddress obj)

public int hashCode(PostalAddress obj)

GetHashCode returns a hash function for specified object.

Parameters:

Parameter Type Description
obj PostalAddress The Object for which a hash code is to be returned.

Returns: int - Returns a hash function for specified object.

equals(PostalAddress obj)

public final boolean equals(PostalAddress obj)

Parameters:

Parameter Type Description
obj PostalAddress

Returns: boolean

equals(Object obj)

public boolean equals(Object obj)

Determines whether the specified Object is equal to the current Object.

Parameters:

Parameter Type Description
obj java.lang.Object The Object to compare with the current Object.

Returns: boolean - Returns a boolean indicating if the passed in object obj is Equal to this.

equals(PostalAddress x, PostalAddress y)

public final boolean equals(PostalAddress x, PostalAddress y)

Determines whether the specified object instances are considered equal.

Parameters:

Parameter Type Description
x PostalAddress The first object to compare.
y PostalAddress The second object to compare.

Returns: boolean - true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

op_Equality(PostalAddress a, PostalAddress b)

public static boolean op_Equality(PostalAddress a, PostalAddress b)

Determines whether the specified objects are equal.

Parameters:

Parameter Type Description
a PostalAddress First object to compare
b PostalAddress Second object to compare

Returns: boolean - Returns true if objects are equal, otherwise false.

op_Inequality(PostalAddress a, PostalAddress b)

public static boolean op_Inequality(PostalAddress a, PostalAddress b)

Determines whether the specified objects are not equal.

Parameters:

Parameter Type Description
a PostalAddress First object to compare
b PostalAddress Second object to compare

Returns: boolean - Returns true if objects are not equal, otherwise false.

compareTo(PostalAddress obj)

public int compareTo(PostalAddress obj)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters:

Parameter Type Description
obj PostalAddress An object to compare with this instance, or null.

Returns: int - This method returns: a value less than 0 if this is less than value 0 if this is equal to value a value greater than 0 if this is greater than value