AddressBookRecord.java

/*
 * AddressBookRecord.java
 *
 * Copyright � 1998-2011 Research In Motion Limited
 * 
 * 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.
 *
 * Note: For the sake of simplicity, this sample application may not leverage
 * resource bundles and resource strings.  However, it is STRONGLY recommended
 * that application developers make use of the localization features available
 * within the BlackBerry development platform to ensure a seamless application
 * experience across a variety of languages and geographies.  For more information
 * on localizing your application, please refer to the BlackBerry Java Development
 * Environment Development Guide associated with this release.
 */

package com.rim.samples.device.objectgroupingdemo;

import net.rim.device.api.util.Persistable;

/**
 * This class represents the record object for the address book record sample
 * code. It is a persistent object and is intended to showcase how grouping
 * would be applied to this object.
 */
public class AddressBookRecord implements Persistable {
    private String _title; // The title of the address book record
    private String _firstName; // The first name of the address book record
    private String _lastName; // The last name of the address book record

    /**
     * Create an empty version of the AddressBookRecord
     */
    public AddressBookRecord() {
        _title = "";
        _firstName = "";
        _lastName = "";
    }

    /**
     * Create a new AddressBookRecord with the specified title, first name and
     * last name
     * 
     * @param title
     *            The title of the AddressBookRecord
     * @param firstName
     *            The first name of the AddressBookRecord
     * @param lastName
     *            The last name of the AddressBookRecord
     * @throws IllegalArgumentException
     *             if any of the parameters are null
     */
    AddressBookRecord(final String title, final String firstName,
            final String lastName) {
        if (title == null || firstName == null || lastName == null) {
            throw new IllegalArgumentException();
        }
        _title = title;
        _firstName = firstName;
        _lastName = lastName;
    }

    /**
     * Returns the title of the AddressBookRecord
     * 
     * @return The title of the AddressBookRecord
     */
    String getTitle() {
        return _title;
    }

    /**
     * Returns the first name of the AddressBookRecord
     * 
     * @return The first name of the AddressBookRecord
     */
    String getFirstName() {
        return _firstName;
    }

    /**
     * Returns the last name of the AddressBookRecord
     * 
     * @return The last name of the AddressBookRecord
     */
    String getLastName() {
        return _lastName;
    }

    /**
     * Sets the title of the AddressBookRecord
     * 
     * @param title
     *            The new title of the AddressBookRecord
     */
    void setTitle(final String title) {
        _title = title;
    }

    /**
     * Sets the first name of the AddressBookRecord
     * 
     * @param firstName
     *            The new first name of the AddressBookRecord
     */
    void setFirstName(final String firstName) {
        _firstName = firstName;
    }

    /**
     * Sets the last name of the AddressBookRecord
     * 
     * @param lastName
     *            The new last name of the AddressBookRecord
     */
    void setLastName(final String lastName) {
        _lastName = lastName;
    }

    /**
     * @see java.lang.Object#equals(Object)
     */
    public boolean equals(final Object obj) {
        if (obj == this) {
            return true;
        }

        if (obj instanceof AddressBookRecord) {
            final AddressBookRecord other = (AddressBookRecord) obj;
            if (!other._title.equals(_title)) {
                return false;
            }
            if (!other._firstName.equals(_firstName)) {
                return false;
            }
            if (!other._lastName.equals(_lastName)) {
                return false;
            }
            return true;
        }
        return false;
    }
}