/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package info.ineighborhood.cardme.vcard.types;
import info.ineighborhood.cardme.util.Util;
import info.ineighborhood.cardme.vcard.EncodingType;
import info.ineighborhood.cardme.vcard.VCardType;
import info.ineighborhood.cardme.vcard.features.AddressFeature;
import info.ineighborhood.cardme.vcard.types.parameters.AddressParameterType;
import info.ineighborhood.cardme.vcard.types.parameters.ParameterTypeStyle;
import info.ineighborhood.cardme.vcard.types.parameters.XAddressParameterType;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
/**
* Copyright (c) 2004, Neighborhood Technologies
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of Neighborhood Technologies nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* 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.
*/
/**
*
* @author George El-Haddad
* <br/>
* Feb 4, 2010
*
*/
public class AddressType extends Type implements AddressFeature {
private String postOfficeBox = null;
private String extendedAddress = null;
private String streetAddress = null;
private String locality = null;
private String region = null;
private String postalCode = null;
private String countryName = null;
private List<AddressParameterType> addressParameterTypes = null;
private List<XAddressParameterType> xtendedAddressParameterTypes = null;
public AddressType() {
super(EncodingType.EIGHT_BIT, ParameterTypeStyle.PARAMETER_VALUE_LIST);
addressParameterTypes = new ArrayList<AddressParameterType>();
xtendedAddressParameterTypes = new ArrayList<XAddressParameterType>();
}
/**
* {@inheritDoc}
*/
public String getPostOfficeBox()
{
return postOfficeBox;
}
/**
* {@inheritDoc}
*/
public String getExtendedAddress()
{
return extendedAddress;
}
/**
* {@inheritDoc}
*/
public String getStreetAddress()
{
return streetAddress;
}
/**
* {@inheritDoc}
*/
public String getLocality()
{
return locality;
}
/**
* {@inheritDoc}
*/
public String getRegion()
{
return region;
}
/**
* {@inheritDoc}
*/
public String getPostalCode()
{
return postalCode;
}
/**
* {@inheritDoc}
*/
public String getCountryName()
{
return countryName;
}
/**
* {@inheritDoc}
*/
public void setStreetAddress(String streetAddress)
{
this.streetAddress = streetAddress;
}
/**
* {@inheritDoc}
*/
public void setPostOfficeBox(String postOfficeBox) {
this.postOfficeBox = postOfficeBox;
}
/**
* {@inheritDoc}
*/
public void setExtendedAddress(String extendedAddress) {
this.extendedAddress = extendedAddress;
}
/**
* {@inheritDoc}
*/
public void setLocality(String locality) {
this.locality = locality;
}
/**
* {@inheritDoc}
*/
public void setRegion(String region) {
this.region = region;
}
/**
* {@inheritDoc}
*/
public void setPostalCode(String postalCode) {
this.postalCode = postalCode;
}
/**
* {@inheritDoc}
*/
public void setCountryName(String countryName) {
this.countryName = countryName;
}
/**
* {@inheritDoc}
*/
public Iterator<AddressParameterType> getAddressParameterTypes()
{
return addressParameterTypes.listIterator();
}
/**
* {@inheritDoc}
*/
public List<AddressParameterType> getAddressParameterTypesList()
{
return Collections.unmodifiableList(addressParameterTypes);
}
/**
* {@inheritDoc}
*/
public int getAddressParameterSize()
{
return addressParameterTypes.size();
}
/**
* {@inheritDoc}
*/
public void addAddressParameterType(AddressParameterType addressParameterType) {
addressParameterTypes.add(addressParameterType);
}
/**
* {@inheritDoc}
*/
public void removeAddressParameterType(AddressParameterType addressParameterType) {
addressParameterTypes.remove(addressParameterType);
}
/**
* {@inheritDoc}
*/
public boolean containsAddressParameterType(AddressParameterType addressParameterType)
{
return addressParameterTypes.contains(addressParameterType);
}
/**
* {@inheritDoc}
*/
public void clearAddressParameterTypes() {
addressParameterTypes.clear();
}
/**
* {@inheritDoc}
*/
public Iterator<XAddressParameterType> getExtendedAddressParameterTypes()
{
return xtendedAddressParameterTypes.listIterator();
}
/**
* {@inheritDoc}
*/
public List<XAddressParameterType> getExtendedAddressParameterTypesList()
{
return Collections.unmodifiableList(xtendedAddressParameterTypes);
}
/**
* {@inheritDoc}
*/
public int getExtendedAddressParameterSize()
{
return xtendedAddressParameterTypes.size();
}
/**
* {@inheritDoc}
*/
public void addExtendedAddressParameterType(XAddressParameterType xtendedAddressParameterType) {
xtendedAddressParameterTypes.add(xtendedAddressParameterType);
}
/**
* {@inheritDoc}
*/
public void removeExtendedAddressParameterType(XAddressParameterType xtendedAddressParameterType) {
xtendedAddressParameterTypes.remove(xtendedAddressParameterType);
}
/**
* {@inheritDoc}
*/
public boolean containsExtendedAddressParameterType(XAddressParameterType xtendedAddressParameterType)
{
return xtendedAddressParameterTypes.contains(xtendedAddressParameterType);
}
/**
* {@inheritDoc}
*/
public boolean hasExtendedAddressParameterTypes()
{
return !xtendedAddressParameterTypes.isEmpty();
}
/**
* {@inheritDoc}
*/
public boolean hasPostOfficebox()
{
return postOfficeBox != null;
}
/**
* {@inheritDoc}
*/
public boolean hasExtendedAddress()
{
return extendedAddress != null;
}
/**
* {@inheritDoc}
*/
public boolean hasLocality()
{
return locality != null;
}
/**
* {@inheritDoc}
*/
public boolean hasRegion()
{
return region != null;
}
/**
* {@inheritDoc}
*/
public boolean hasPostalCode()
{
return postalCode != null;
}
/**
* {@inheritDoc}
*/
public boolean hasCountryName()
{
return countryName != null;
}
/**
* {@inheritDoc}
*/
public boolean hasStreetAddress()
{
return streetAddress != null;
}
/**
* {@inheritDoc}
*/
public boolean hasAddressParameterTypes()
{
return !addressParameterTypes.isEmpty();
}
/**
* {@inheritDoc}
*/
@Override
public String getTypeString()
{
return VCardType.ADR.getType();
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object obj)
{
if(obj != null) {
if(obj instanceof AddressType) {
if(this == obj || ((AddressType)obj).hashCode() == this.hashCode()) {
return true;
}
else {
return false;
}
}
else {
return false;
}
}
else {
return false;
}
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode()
{
return Util.generateHashCode(toString());
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
StringBuilder sb = new StringBuilder();
sb.append(this.getClass().getName());
sb.append("[ ");
if(encodingType != null) {
sb.append(encodingType.getType());
sb.append(",");
}
if(postOfficeBox != null) {
sb.append(postOfficeBox);
sb.append(",");
}
if(extendedAddress != null) {
sb.append(extendedAddress);
sb.append(",");
}
if(streetAddress != null) {
sb.append(streetAddress);
sb.append(",");
}
if(locality != null) {
sb.append(locality);
sb.append(",");
}
if(region != null) {
sb.append(region);
sb.append(",");
}
if(postalCode != null) {
sb.append(postalCode);
sb.append(",");
}
if(countryName != null) {
sb.append(countryName);
sb.append(",");
}
if(!addressParameterTypes.isEmpty()) {
for(int i = 0; i < addressParameterTypes.size(); i++) {
sb.append(addressParameterTypes.get(i).getType());
sb.append(",");
}
}
if(!xtendedAddressParameterTypes.isEmpty()) {
for(int i = 0; i < xtendedAddressParameterTypes.size(); i++) {
sb.append(xtendedAddressParameterTypes.get(i).getType());
sb.append(",");
}
}
if(super.id != null) {
sb.append(super.id);
sb.append(",");
}
sb.deleteCharAt(sb.length()-1); //Remove last comma.
sb.append(" ]");
return sb.toString();
}
/**
* {@inheritDoc}
*/
@Override
public AddressFeature clone()
{
AddressType cloned = new AddressType();
if(postOfficeBox != null) {
cloned.setPostOfficeBox(postOfficeBox);
}
if(extendedAddress != null) {
cloned.setExtendedAddress(extendedAddress);
}
if(streetAddress != null) {
cloned.setExtendedAddress(streetAddress);
}
if(locality != null) {
cloned.setLocality(locality);
}
if(region != null) {
cloned.setRegion(region);
}
if(postalCode != null) {
cloned.setPostalCode(postalCode);
}
if(countryName != null) {
cloned.setCountryName(countryName);
}
if(!addressParameterTypes.isEmpty()) {
for (AddressParameterType addressParameterType : addressParameterTypes) {
cloned.addAddressParameterType(addressParameterType);
}
}
if(!xtendedAddressParameterTypes.isEmpty()) {
for (XAddressParameterType xtendedAddressParameterType : xtendedAddressParameterTypes) {
cloned.addExtendedAddressParameterType(xtendedAddressParameterType);
}
}
cloned.setParameterTypeStyle(getParameterTypeStyle());
cloned.setEncodingType(getEncodingType());
cloned.setID(getID());
return cloned;
}
}