com.mongodb.ServerCursor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can ' + 'wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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.mongodb;

import com.mongodb.annotations.Immutable;

import java.io.Serializable;

/**
 * A class representing a cursor id associated with a server address (host/port) Since cursor ids are only useful in the context of a single
 * MongoDB server process, you need both values to do a getMore on the cursor.
 *
 * @since 3.0
 */
@Immutable
public final class ServerCursor implements Serializable {

    private static final long serialVersionUID = -7013636754565190109L;

    /**
     * The cursor id.
     */
    private final long id;
    /**
     * The server address.
     */
    private final ServerAddress address;

    /**
     * Construct an instance.
     *
     * @param id  the non-null cursor id
     * @param address the non-null server address that has the cursor
     */
    public ServerCursor(final long id, final ServerAddress address) {
        if (id == 0) {
            throw new IllegalArgumentException();
        }
        this.id = id;
        this.address = address;
    }

    /**
     * Gets the cursor id that the server uses to uniquely identify the cursor.
     *
     * @return the cursor id
     */
    public long getId() {
        return id;
    }

    /**
     * Gets the server address.
     *
     * @return the server address
     */
    public ServerAddress getAddress() {
        return address;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        ServerCursor that = (ServerCursor) o;

        if (id != that.id) {
            return false;
        }
        if (!address.equals(that.address)) {
            return false;
        }

        return true;
    }

    @Override
    public int hashCode() {
        int result = (int) (id ^ (id >>> 32));
        result = 31 * result + (address.hashCode());
        return result;
    }

    @Override
    public String toString() {
        return "ServerCursor{getId=" + id + ", address=" + address + '}';
    }
}