org.apache.lucene.document

Class XInetAddressPoint

java.lang.Object

org.apache.lucene.document.XInetAddressPoint

public final class XInetAddressPoint
extends java.lang.Object

Forked utility methods from Lucene's InetAddressPoint until LUCENE-7232 and LUCENE-7234 are released.

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.InetAddress	MAX_VALUE The maximum value that an ip address can hold.
static java.net.InetAddress	MIN_VALUE The minimum value that an ip address can hold.

Method Summary

Modifier and Type	Method and Description
static org.apache.lucene.search.Query	newPrefixQuery(java.lang.String field, java.net.InetAddress value, int prefixLength) Create a prefix query for matching a CIDR network range.
static java.net.InetAddress	nextDown(java.net.InetAddress address) Return the InetAddress that compares immediately less than address.
static java.net.InetAddress	nextUp(java.net.InetAddress address) Return the InetAddress that compares immediately greater than address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_VALUE

public static final java.net.InetAddress MIN_VALUE

The minimum value that an ip address can hold.

MAX_VALUE

public static final java.net.InetAddress MAX_VALUE

The maximum value that an ip address can hold.

Method Detail

nextUp

public static java.net.InetAddress nextUp(java.net.InetAddress address)

Return the InetAddress that compares immediately greater than address.

Throws:

java.lang.ArithmeticException - if the provided address is the maximum ip address

nextDown

public static java.net.InetAddress nextDown(java.net.InetAddress address)

Return the InetAddress that compares immediately less than address.

Throws:

java.lang.ArithmeticException - if the provided address is the minimum ip address

newPrefixQuery

public static org.apache.lucene.search.Query newPrefixQuery(java.lang.String field,
                                                            java.net.InetAddress value,
                                                            int prefixLength)

Create a prefix query for matching a CIDR network range.

Parameters:

field - field name. must not be null.

value - any host address

prefixLength - the network prefix length for this address. This is also known as the subnet mask in the context of IPv4 addresses.

Returns:

a query matching documents with addresses contained within this network

Throws:

java.lang.IllegalArgumentException - if field is null, or prefixLength is invalid.