2 * Copyright (C) 2016 - 2018 Free Software Foundation
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 package org.mxchange.jcontacts.model.contact;
19 import java.io.Serializable;
20 import java.util.Objects;
21 import org.mxchange.jcountry.model.data.Country;
22 import org.mxchange.jphone.model.phonenumbers.fax.DialableFaxNumber;
23 import org.mxchange.jphone.model.phonenumbers.fax.FaxNumber;
24 import org.mxchange.jphone.model.phonenumbers.landline.DialableLandLineNumber;
25 import org.mxchange.jphone.model.phonenumbers.landline.LandLineNumber;
26 import org.mxchange.jphone.model.phonenumbers.mobile.DialableMobileNumber;
27 import org.mxchange.jphone.model.phonenumbers.mobile.MobileNumber;
28 import org.mxchange.jphone.model.phonenumbers.mobileprovider.MobileProvider;
31 * Utilities for contacts
33 * @author Roland Häder<roland@mxchange.org>
35 public class Contacts implements Serializable {
40 private static final long serialVersionUID = 26_785_734_719_670L;
43 * Compares both contact instances. This method returns -1 if second
46 * @param contact1 Contact instance 1
47 * @param contact2 Contact instance 2
49 * @return Comparison value
51 * @throws NullPointerException If first instance is null
53 public static int compare (final Contact contact1, final Contact contact2) {
54 // Check euqality, then at least first must be given
55 if (Objects.equals(contact1, contact2)) {
58 } else if (null == contact1) {
59 // First cannot be null
60 throw new NullPointerException("contact1 is null"); //NOI18N
61 } else if (null == contact2) {
66 // Invoke compareTo() method
67 return contact1.compareTo(contact2);
71 * Copies all attributes from other contact object to this
73 * @param sourceContact Source instance
74 * @param targetContact Target instance
76 public static void copyAll (final Contact sourceContact, final Contact targetContact) {
77 // Contact should be valid
78 if (null == sourceContact) {
80 throw new NullPointerException("sourceContact is null"); //NOI18N
81 } else if (null == targetContact) {
83 throw new NullPointerException("targetContact is null"); //NOI18N
88 targetContact.setContactPersonalTitle(sourceContact.getContactPersonalTitle());
89 targetContact.setContactTitle(sourceContact.getContactTitle());
90 targetContact.setContactFirstName(sourceContact.getContactFirstName());
91 targetContact.setContactFamilyName(sourceContact.getContactFamilyName());
92 targetContact.setContactStreet(sourceContact.getContactStreet());
93 targetContact.setContactHouseNumber(sourceContact.getContactHouseNumber());
94 targetContact.setContactHouseNumberExtension(sourceContact.getContactHouseNumberExtension());
95 targetContact.setContactZipCode(sourceContact.getContactZipCode());
96 targetContact.setContactCity(sourceContact.getContactCity());
97 targetContact.setContactCountry(sourceContact.getContactCountry());
99 // - phone, fax, email
100 targetContact.setContactLandLineNumber(sourceContact.getContactLandLineNumber());
101 targetContact.setContactFaxNumber(sourceContact.getContactFaxNumber());
102 targetContact.setContactMobileNumber(sourceContact.getContactMobileNumber());
105 targetContact.setContactBirthday(sourceContact.getContactBirthday());
106 targetContact.setContactComment(sourceContact.getContactComment());
107 targetContact.setContactCreated(sourceContact.getContactCreated());
108 targetContact.setContactUpdated(sourceContact.getContactUpdated());
112 * Checks whether both contacts are same, but ignoring id number. If you
113 * want to include id number in comparison, better use Objects.equals() as
114 * the equal() method is implemented and checks all fields.
116 * @param contact Contact one
117 * @param other Contact two
119 * @return Whether both are the same
121 public static boolean isSameContact (final Contact contact, final Contact other) {
122 // Both should not be null
123 if (null == contact) {
124 // First contact is null
125 throw new NullPointerException("contact is null"); //NOI18N
126 } else if (null == other) {
127 // Secondcontact is null
128 throw new NullPointerException("other is null"); //NOI18N
131 // Check all data fields, except id number
132 return ((Objects.equals(contact.getContactBirthday(), other.getContactBirthday())) &&
133 (Objects.equals(contact.getContactCity(), other.getContactCity())) &&
134 (Objects.equals(contact.getContactCountry(), other.getContactCountry())) &&
135 (Objects.equals(contact.getContactEmailAddress(), other.getContactEmailAddress())) &&
136 (Objects.equals(contact.getContactFamilyName(), other.getContactFamilyName())) &&
137 (Objects.equals(contact.getContactFirstName(), other.getContactFirstName())) &&
138 (Objects.equals(contact.getContactPersonalTitle(), other.getContactPersonalTitle())) &&
139 (Objects.equals(contact.getContactHouseNumber(), other.getContactHouseNumber())) &&
140 (Objects.equals(contact.getContactStreet(), other.getContactStreet())) &&
141 (Objects.equals(contact.getContactTitle(), other.getContactTitle())) &&
142 (Objects.equals(contact.getContactZipCode(), other.getContactZipCode())));
146 * Updates land-line data in contact instance. This method also removes the
147 * land-line instance if no country is selected. A bean (mostly EJB) should
148 * then make sure that the land-line entry is being unlinked from contact
149 * instance or being removed, if no longer used.
151 * @param contact Contact instance being updated
152 * @param faxCountry Updated fax number or null
153 * @param faxAreaCode Updated fax area code or null
154 * @param faxNumber Updated fax number
156 * @return Whether the fax number has been unlinked in contact object
158 public static boolean updateFaxNumber (final Contact contact, final Country faxCountry, final Integer faxAreaCode, final Long faxNumber) {
159 // At least contact must be valid
160 if (null == contact) {
162 throw new NullPointerException("contact is null"); //NOI18N
165 // Default is not unlinked
166 boolean isUnlinked = false;
168 // Is there a fax instance?
169 if (contact.getContactFaxNumber() instanceof DialableFaxNumber) {
170 // Found existing fax number, remove it?
171 if ((null == faxCountry) || (null == faxAreaCode) || (null == faxNumber)) {
172 // Remove existing instance
173 contact.setContactFaxNumber(null);
175 // Mark it as being removed
179 contact.getContactFaxNumber().setPhoneCountry(faxCountry);
180 contact.getContactFaxNumber().setPhoneAreaCode(faxAreaCode);
181 contact.getContactFaxNumber().setPhoneNumber(faxNumber);
183 } else if ((faxCountry instanceof Country) && (faxAreaCode > 0) && (faxNumber > 0)) {
184 // Set new land-line number
185 DialableFaxNumber fax = new FaxNumber(faxCountry, faxAreaCode, faxNumber);
188 contact.setContactFaxNumber(fax);
196 * Updates land-line data in contact instance. This method also removes the
197 * land-line instance if no country is selected. A bean (mostly EJB) should
198 * then make sure that the land-line entry is being unlinked from contact
199 * instance or being removed, if no longer used.
201 * @param contact Contact instance being updated
202 * @param phoneCountry New phone country or old or null
203 * @param phoneAreaCode New phone's area code (or old)
204 * @param phoneNumber New phone number (or old)
206 * @return Whether the land-line number has been unlinked in contact object
208 public static boolean updateLandLineNumber (final Contact contact, final Country phoneCountry, final Integer phoneAreaCode, final Long phoneNumber) {
209 // At least contact must be valid
210 if (null == contact) {
212 throw new NullPointerException("contact is null"); //NOI18N
215 // Default is not unlinked
216 boolean isUnlinked = false;
218 // Is there a land-line instance?
219 if (contact.getContactLandLineNumber() instanceof DialableLandLineNumber) {
220 // Found existing land-line number, remove it?
221 if ((null == phoneCountry) || (null == phoneAreaCode) || (null == phoneNumber)) {
222 // Remove existing instance
223 contact.setContactLandLineNumber(null);
225 // Mark it as being removed
229 contact.getContactLandLineNumber().setPhoneCountry(phoneCountry);
230 contact.getContactLandLineNumber().setPhoneAreaCode(phoneAreaCode);
231 contact.getContactLandLineNumber().setPhoneNumber(phoneNumber);
233 } else if ((phoneCountry instanceof Country) && (phoneAreaCode > 0) && (phoneNumber > 0)) {
234 // Set new land-line number
235 DialableLandLineNumber landLine = new LandLineNumber(phoneCountry, phoneAreaCode, phoneNumber);
238 contact.setContactLandLineNumber(landLine);
246 * Updates mobile data in contact instance. This method also removes the
247 * mobile instance if no provider is selected. A bean (mostly EJB) should
248 * then make sure that the mobile entry is being unlinked from contact
249 * instance or being removed, if no longer used.
251 * @param contact Contact instance to update
252 * @param mobileProvider New mobile provider (or old)
253 * @param mobileNumber New mobile number (or old)
255 * @return Whether the mobile has been unlinked in contact object
257 public static boolean updateMobileNumber (final Contact contact, final MobileProvider mobileProvider, final Long mobileNumber) {
258 // At least contact must be valid
259 if (null == contact) {
261 throw new NullPointerException("contact is null"); //NOI18N
262 } else if ((mobileProvider instanceof MobileProvider) && (null == mobileNumber)) {
263 // Mobile provider given, but no number
264 throw new NullPointerException("mobileNumber is null"); //NOI18N
267 // Default is not unlinked
268 boolean isUnlinked = false;
270 // Is there a mobile number?
271 if (contact.getContactMobileNumber() instanceof DialableMobileNumber) {
273 if ((null == mobileProvider) || (null == mobileNumber) || (mobileNumber == 0)) {
275 contact.setContactMobileNumber(null);
280 // Yes, then update as well
281 contact.getContactMobileNumber().setMobileProvider(mobileProvider);
282 contact.getContactMobileNumber().setPhoneNumber(mobileNumber);
284 } else if ((mobileProvider instanceof MobileProvider) && (mobileNumber > 0)) {
285 // Create new instance
286 DialableMobileNumber mobile = new MobileNumber(mobileProvider, mobileNumber);
289 contact.setContactMobileNumber(mobile);
297 * Private constructor for utilities
299 private Contacts () {