Id.java

/*
 * Copyright © 2013. Palomino Labs (http://palominolabs.com)
 *
 * 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.palominolabs.crm.sf.core;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Represents an SF record Id. Remember to use .equals(Id otherID) to check equality.
 */
@Immutable
public final class Id {

    /**
     * the sf record id string
     */
    @Nonnull
    private final String idStr;

    /**
     * @param id the sf record id to wrap. Must not be null. It can be 15 or 18 characters long, but it will be
     *           truncated to 15 characters either way.
     */
    public Id(@Nonnull String id) {
        this.idStr = checkNotNull(id, "An Id must have a non-null string");

        if (id.length() != 15 && id.length() != 18) {
            throw new IllegalArgumentException(
                    "Salesforce Ids must be either 15 or 18 characters, was <" + id + "> (" + id.length() + ")");
        }
    }

    @Nonnull
    public String getKeyPrefix() {
        return idStr.substring(0, 3);
    }
    
    /**
     * @return Return the case-insensitive, 18 character id, if this object was constructed with an 18 character id.
     *          If the object was constructed with a 15 character ID, then this returns the same as getIdStr()
     */
    @Nonnull
    public String getFullId(){
    	return this.idStr;
    }

    /**
     * @return 15-character, case-sensitive id string
     */
    @Nonnull
    public String getIdStr() {
        return this.idStr.substring(0, 15);
    }

    /**
     * @return 15-character case sensitive id string
     */
    @Override
    @Nonnull
    public String toString() {
        return this.getIdStr();
    }

    @Override
    public boolean equals(Object other) {
        if (other instanceof Id) {
            return this.getIdStr().equals(((Id) other).getIdStr());
        }
        return false;
    }

    @Override
    public int hashCode() {
        return this.getIdStr().hashCode();
    }
}