com.maxmind.db.DatabaseRecord Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maxmind-db Show documentation

Reader for MaxMind DB

The newest version!

package com.maxmind.db;

import java.net.InetAddress;

/**
 * DatabaseRecord represents the data and metadata associated with a database
 * lookup.
 *
 * @param  the type to deserialize the returned value to
 */
public final class DatabaseRecord {
    private final T data;
    private final Network network;

    /**
     * Create a new record.
     *
     * @param data         the data for the record in the database.
     * @param ipAddress    the IP address used in the lookup.
     * @param prefixLength the network prefix length associated with the record in the database.
     */
    public DatabaseRecord(T data, InetAddress ipAddress, int prefixLength) {
        this.data = data;
        this.network = new Network(ipAddress, prefixLength);
    }

    /**
     * @return the data for the record in the database. The record will be
     *         null if there was no data for the address in the
     *         database.
     */
    public T getData() {
        return data;
    }

    /**
     * @return the network associated with the record in the database. This is
     *         the largest network where all of the IPs in the network have the same
     *         data.
     */
    public Network getNetwork() {
        return network;
    }
}