Android Open Source - ean-android Address

• Back to Network/sample  ↑

From Project

Back to project page ean-android.

License

The source code is released under:

Copyright (c) 2013, Expedia Affiliate Network All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that redistributions of sour...

Java Source Code

/*
 * Copyright (c) 2013, Expedia Affiliate Network
 * All rights reserved.//w ww  . j av  a  2s. co  m
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that redistributions of source code
 * retain the above copyright notice, these conditions, and the following
 * disclaimer. 
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies, 
 * either expressed or implied, of the Expedia Affiliate Network or Expedia Inc.
 */

package com.ean.mobile;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;

import org.apache.http.NameValuePair;
import org.apache.http.message.BasicNameValuePair;
import org.json.JSONObject;

/**
 * Container for address information. Should handle any international address.
 * If the address is invalid in some way, the validationErrors list will delineate in what way it is invalid. This
 * is in lieu of throwing exceptions since there are potentially unaccounted for address types which may be stored
 * with this object, and there's no need to throw exceptions for partial addresses.
 */
public class Address {

    /**
     * The country codes wherein a state code is supported and required.
     */
    public static final Set<String> VALID_STATE_PROVINCE_CODE_COUNTRY_CODES
        = Collections.unmodifiableSet(new HashSet<String>(Arrays.asList("US", "CA", "AU")));

    /**
     * An ordered list of address lines, starting with address line 1 and maxing out around 3.
     */
    public final List<String> lines;

    /**
     * The city associated with this address.
     */
    public final String city;

    /**
     * The two-character code for the state/province containing the specified city. Only valid for cities in Australia,
     * Canada, and The United States.
     */
    public final String stateProvinceCode;

    /**
     * Two-character <a href="http://www.iso.org/iso/home/standards/country_codes/iso-3166-1_decoding_table.htm">
     *     ISO-3166</a> code for the country of this address.
     */
    public final String countryCode;

    /**
     * The postal code associated with this address. Will accept any international format.
     */
    public final String postalCode;

    /**
     * The cached representation of this object as a string. Used to prevent the string from needing to be constructed
     * every time the toString method is called.
     */
    private transient String asString;

    /**
     * Creates an address object from a JSONObject which has the appropriate address fields.
     * @param object The JSONObject from which to construct the address.
     */
    public Address(final JSONObject object) {
        final List<String> localLines = new LinkedList<String>();
        String line;
        for (int i = 1; object.has("address" + i); i++) {
            line = object.optString("address" + i);
            if (line != null && !"".equals(line)) {
                localLines.add(line);
            }
        }

        this.lines = Collections.unmodifiableList(localLines);
        this.city = object.optString("city");
        this.stateProvinceCode = object.optString("stateProvinceCode");
        this.countryCode = object.optString("countryCode");
        this.postalCode = object.optString("postalCode");
    }

    /**
     * Creates an address object from the various parameters.
     * @param addressLines The lines of the address.
     * @param city City of address.
     * @param stateProvinceCode State/province code for state.
     * @param countryCode ISO country code for country.
     * @param postalCode Postal code for country.
     */
    public Address(final List<String> addressLines, final String city, final String stateProvinceCode,
            final String countryCode, final String postalCode) {
        lines = Collections.unmodifiableList(addressLines);
        this.city = city;
        this.stateProvinceCode = stateProvinceCode;
        this.countryCode = countryCode;
        this.postalCode = postalCode;
    }

    /**
     * Gets NameValuePairs for the address information so it can be sent in a rest request.
     * @return The requested NameValuePairs
     */
    public List<NameValuePair> asBookingRequestPairs() {
        final List<NameValuePair> addressPairs = new LinkedList<NameValuePair>();
        final Iterator<String> lineIterator = lines.iterator();
        for (int i = 1; lineIterator.hasNext(); i++) {
            addressPairs.add(new BasicNameValuePair("address" + i, lineIterator.next()));
        }
        addressPairs.add(new BasicNameValuePair("city", city));
        if (VALID_STATE_PROVINCE_CODE_COUNTRY_CODES.contains(countryCode)) {
            addressPairs.add(new BasicNameValuePair("stateProvinceCode", stateProvinceCode));
        }
        addressPairs.add(new BasicNameValuePair("countryCode", countryCode));
        addressPairs.add(new BasicNameValuePair("postalCode", postalCode));

        return Collections.unmodifiableList(addressPairs);
    }

    /**
     * Returns a formatted string representing this address as it would appear on an envelope.
     * @return The formatted address.
     */
    @Override
    public String toString() {
        if (asString != null) {
            return asString;
        }
        final StringBuilder addressBuilder = new StringBuilder();
        for (String line : lines) {
            addressBuilder.append(line);
            addressBuilder.append("\n");
        }
        addressBuilder.append(city);
        addressBuilder.append(" ");
        addressBuilder.append(stateProvinceCode);
        addressBuilder.append(" ");
        addressBuilder.append(postalCode);
        addressBuilder.append("\n");
        addressBuilder.append(countryCode);
        asString = addressBuilder.toString();
        return asString;
    }

}

Java Source Code List

• Back to Network/sample  ↑