org.swiftsms.utils

Class ContactUtils

java.lang.Object

org.swiftsms.utils.ContactUtils

public class ContactUtils
extends Object

A utility class to help with entering multiple contacts in the UI Recipients EditText.

Constructor Summary

Constructors

Constructor and Description
ContactUtils()

Method Summary

Modifier and Type	Method and Description
static <T> List<List<T>>	chopped(List<T> list, int length) Method to break a List into multiple smaller lists.
static String	getAllButLastContacts(String recipients) This method is used to get only the fully entered contacts from a string.
static List<String>	getContactsAsList(String recipients) This method is used to convert a String version of a list of contacts to an array of formatted numbers that can be used for sending an SMS.
static String	getLastContact(String recipients) This method returns the text that follows the last contact separator in the string.
static boolean	hasMultipleContacts(String recipients) This method determines if there is more than one contact entered in a String.
static boolean	isNumber(String number) Method to check if a String is a valid phone number.
static String	removeIrishPrefix(String recipient) This method is used to replace the Irish +353 prefix with a 0.
static List<String>	removeIrishPrefixFromRecipients(List<String> recipients) This method is used to replace the Irish +353 prefix with a 0.
static String	trimSeparators(String recipients) This method is used to remove unneeded contact separator characters from a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactUtils

public ContactUtils()

Method Detail

chopped

public static <T> List<List<T>> chopped(List<T> list,
                                        int length)

Method to break a List into multiple smaller lists.

Type Parameters:

T - The type of elements which the list contains.

Parameters:

list - The larger list to be broken down.

length - The max length of a returned List.

Returns:

A List containing the smaller broken down lists.

hasMultipleContacts

public static boolean hasMultipleContacts(String recipients)

This method determines if there is more than one contact entered in a String. This is determined by the separator character. If the separator character exists in the string it is assumed more than one contact exists in the string.

Parameters:

recipients - A string containing one or more contacts.

Returns:

true if there is more than one contact, otherwise false.

getAllButLastContacts

public static String getAllButLastContacts(String recipients)

This method is used to get only the fully entered contacts from a string. It returns everything up to the last separator character. It does no validation that the contacts are valid.

Parameters:

recipients - A string containing one or more contacts.

Returns:

A String containing all the fully entered contacts.

getLastContact

public static String getLastContact(String recipients)

This method returns the text that follows the last contact separator in the string. If no separators exist in the string the string itself will be returned.

Parameters:

recipients - The string to search.

Returns:

The last contact in the string.

getContactsAsList

public static List<String> getContactsAsList(String recipients)

This method is used to convert a String version of a list of contacts to an array of formatted numbers that can be used for sending an SMS.

Parameters:

recipients - A string containing one or more contacts.

Returns:

A list of numbers taken from the contacts in String.

trimSeparators

public static String trimSeparators(String recipients)

This method is used to remove unneeded contact separator characters from a String. It will remove all contact separator characters from the string if they are 'empty'.

Parameters:

recipients - A string containing one or more contacts.

Returns:

A String containing the recipients without leading or trailing separator characters.

removeIrishPrefix

public static String removeIrishPrefix(String recipient)

This method is used to replace the Irish +353 prefix with a 0.

Parameters:

recipient - A phone number to remove the Irish prefix from.

Returns:

The String containing the number with the new prefix of zero.

removeIrishPrefixFromRecipients

public static List<String> removeIrishPrefixFromRecipients(List<String> recipients)

This method is used to replace the Irish +353 prefix with a 0.

Parameters:

recipients - Recipient List to remove Irish prefix from, '+353' to '0'.

Returns:

A List containing the recipients with the new prefix of zero.

isNumber

public static boolean isNumber(String number)

Method to check if a String is a valid phone number.

A valid phone number contains only numbers and can optionally start with a +.

Parameters:

number - The String to be tested.

Returns:

true if the String is a valid phone number, otherwise false.