src/com/android/contacts/common/list/ContactEntry.java

/*
 * Copyright (C) 2013 The Android Open Source Project
 *
 * Licensed 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 com.android.contacts.common.list;

import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.provider.ContactsContract.PinnedPositions;
import android.text.TextUtils;

import com.android.contacts.common.preference.ContactsPreferences;

/**
 * Class to hold contact information
 */
public class ContactEntry {

    private static final int UNSET_DISPLAY_ORDER_PREFERENCE = -1;

    /**
     * Primary name for a Contact
     */
    public String namePrimary;
    /**
     * Alternative name for a Contact, e.g. last name first
     */
    public String nameAlternative;
    /**
     * The user's preference on name display order, last name first or first time first.
     * {@see ContactsPreferences}
     */
    public int nameDisplayOrder = UNSET_DISPLAY_ORDER_PREFERENCE;

    public String status;
    public String phoneLabel;
    public String phoneNumber;
    public Uri photoUri;
    public Uri lookupUri;
    public String lookupKey;
    public Drawable presenceIcon;
    public long id;
    public int pinned = PinnedPositions.UNPINNED;
    public boolean isFavorite = false;
    public boolean isDefaultNumber = false;

    public static final ContactEntry BLANK_ENTRY = new ContactEntry();

    public String getPreferredDisplayName() {
        if (nameDisplayOrder == UNSET_DISPLAY_ORDER_PREFERENCE
                || nameDisplayOrder == ContactsPreferences.DISPLAY_ORDER_PRIMARY
                || TextUtils.isEmpty(nameAlternative)) {
            return namePrimary;
        }
        return nameAlternative;
    }
}