com.tomash.androidcontacts.contactgetter.main.contactsGetter

Class ContactsGetterBuilder

java.lang.Object

com.tomash.androidcontacts.contactgetter.main.contactsGetter.ContactsGetterBuilder

public class ContactsGetterBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ContactsGetterBuilder(android.content.Context ctx)

Method Summary

Modifier and Type	Method and Description
ContactsGetterBuilder	addField(FieldType... fieldType) Enables fields that should be queried
ContactsGetterBuilder	allFields() Enables all fields for query
ContactsGetterBuilder	applyCustomFilter(BaseFilter filter) Applies custom filter to query on contacts list
java.util.List<ContactData>	buildList() Builds list of contacts
<T extends ContactData> java.util.List<T>	buildList(java.lang.Class<? extends ContactData> T) Builds list of contacts
ContactData	firstOrNull() Get first contact of null if no contacts with these params
<T extends ContactData> T	firstOrNull(java.lang.Class<T> T) Get first contact of null if no contacts with these params
ContactData	getById(int id) Gets contact by local id
<T extends ContactData> T	getById(int id, java.lang.Class<T> T) Gets contact by local id
ContactsGetterBuilder	onlyWithPhones() Should get all contacts or contacts only with phones
ContactsGetterBuilder	onlyWithPhotos() Should get contacts only with photos or not
ContactsGetterBuilder	setSortOrder(Sorting sortOrder) Sets sort order for all contacts
ContactsGetterBuilder	withAddress(java.lang.String number) Searches for contacts with this number Implicitly adds Address field
ContactsGetterBuilder	withAddressLike(java.lang.String sequence) Searches for addresses that contains this sequence Implicitly adds Address field
ContactsGetterBuilder	withEmail(java.lang.String email) Searches for contacts with this email Implicitly adds Email field
ContactsGetterBuilder	withEmailLike(java.lang.String sequence) Searches for contacts that contains sequence Implicitly adds Email field
ContactsGetterBuilder	withName(java.lang.String name) Searches for contacts with this name
ContactsGetterBuilder	withNameLike(java.lang.String nameLike) Searches for contacts with name that contains sequence
ContactsGetterBuilder	withPhone(java.lang.String number) Searches for contacts with this number
ContactsGetterBuilder	withPhoneLike(java.lang.String number) Searches for contacts that contains this number sequence

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactsGetterBuilder

public ContactsGetterBuilder(android.content.Context ctx)

Method Detail

setSortOrder

public ContactsGetterBuilder setSortOrder(Sorting sortOrder)

Sets sort order for all contacts

Sort types could be found here Sorting

By default is ascending by display name

Parameters:

sortOrder - order to sort

onlyWithPhones

public ContactsGetterBuilder onlyWithPhones()

Should get all contacts or contacts only with phones

Note : Will automatically query for phone numbers.

No need to explicitly add Phone numbers to field list

By default returns all contacts

onlyWithPhotos

public ContactsGetterBuilder onlyWithPhotos()

Should get contacts only with photos or not

By default returns all contacts

withNameLike

public ContactsGetterBuilder withNameLike(java.lang.String nameLike)

Searches for contacts with name that contains sequence

Parameters:

nameLike - sequence to search for

withName

public ContactsGetterBuilder withName(java.lang.String name)

Searches for contacts with this name

Parameters:

name - name to search for

withPhoneLike

public ContactsGetterBuilder withPhoneLike(java.lang.String number)

Searches for contacts that contains this number sequence

Parameters:

number - number sequence to search for

withPhone

public ContactsGetterBuilder withPhone(java.lang.String number)

Searches for contacts with this number

Parameters:

number - number to search for

withEmail

public ContactsGetterBuilder withEmail(java.lang.String email)

Searches for contacts with this email Implicitly adds Email field

Parameters:

email - email to search for

withEmailLike

public ContactsGetterBuilder withEmailLike(java.lang.String sequence)

Searches for contacts that contains sequence Implicitly adds Email field

Parameters:

sequence - sequence to search for

withAddress

public ContactsGetterBuilder withAddress(java.lang.String number)

Searches for contacts with this number Implicitly adds Address field

Parameters:

number - number to search for

withAddressLike

public ContactsGetterBuilder withAddressLike(java.lang.String sequence)

Searches for addresses that contains this sequence Implicitly adds Address field

Parameters:

sequence - sequence to search for

applyCustomFilter

public ContactsGetterBuilder applyCustomFilter(BaseFilter filter)

Applies custom filter to query on contacts list

Additional filters and example implementations could be found here FilterUtils

Parameters:

filter - filter to apply

allFields

public ContactsGetterBuilder allFields()

Enables all fields for query

Note : Consider to enable fields you need with addField(FieldType...) to increase performance

addField

public ContactsGetterBuilder addField(FieldType... fieldType)

Enables fields that should be queried

Number of fields influence on performance

Parameters:

fieldType - field type you want to add

buildList

public <T extends ContactData> java.util.List<T> buildList(java.lang.Class<? extends ContactData> T)

Builds list of contacts

Parameters:

T - class of object you want to get data

buildList

public java.util.List<ContactData> buildList()

Builds list of contacts

getById

public ContactData getById(int id)

Gets contact by local id

Parameters:

id - id to search for

Returns:

contact with data specified by options or null if no contact with this id

getById

public <T extends ContactData> T getById(int id,
                                         java.lang.Class<T> T)

Gets contact by local id

Parameters:

id - id to search for

T - class of object you want to get data

Returns:

contact with data specified by options or null if no contact with this id

firstOrNull

public ContactData firstOrNull()

Get first contact of null if no contacts with these params

firstOrNull

public <T extends ContactData> T firstOrNull(java.lang.Class<T> T)

Get first contact of null if no contacts with these params

Parameters:

T - class of object you want to get data