org.firebirdsql.jdbc.FBRowId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc;

import org.firebirdsql.util.ByteArrayHelper;

import java.sql.RowId;
import java.util.Arrays;
import java.util.Objects;

/**
 * Firebird row-id.
 * 
 * This is a thin wrapper around the bytes of a {@code RDB$DB_KEY}.
 * 
 *
 * @author Mark Rotteveel
 * @since 4.0
 */
public final class FBRowId implements RowId {

    private final byte[] rowIdBytes;

    /**
     * Creates an {@code FBRowId} from the provided byte array.
     *
     * @param rowIdBytes
     *         Bytes of the row id
     */
    public FBRowId(byte[] rowIdBytes) {
        this.rowIdBytes = Objects.requireNonNull(rowIdBytes).clone();
    }

    @Override
    public String toString() {
        return ByteArrayHelper.toHexString(rowIdBytes);
    }

    /**
     * {@inheritDoc}
     * 
     * Implementation note: allows for equality with any implementation of {@link java.sql.RowId}.
     * 
     */
    @Override
    public boolean equals(Object obj) {
        // TODO Implementation breaks equality/hashcode contract
        return obj instanceof RowId && Arrays.equals(rowIdBytes, ((RowId) obj).getBytes());
    }

    @Override
    public int hashCode() {
        return Arrays.hashCode(rowIdBytes);
    }

    /**
     * {@inheritDoc}
     * 
     * NOTE: implementation will return a clone of the array.
     * 
     */
    @Override
    public byte[] getBytes() {
        return rowIdBytes.clone();
    }

}