Index

A B C D E F H I L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Serialized Form

A

add(A) - Method in class uk.ipfreely.Address
Addition with overflow.
add(V4) - Method in class uk.ipfreely.V4
 
add(V6) - Method in class uk.ipfreely.V6
 
address(A) - Static method in class uk.ipfreely.sets.AddressSets
Single address as Block.
Address<A> - Class in uk.ipfreely
Abstract IP address type implemented by V4 and V6.
AddressSet<A> - Interface in uk.ipfreely.sets
Discrete set interface of zero to Family.max() Addresses.
AddressSets - Class in uk.ipfreely.sets
Static factory methods for creating AddressSets, Ranges and Blocks.
adjacent(Range<A>) - Method in interface uk.ipfreely.sets.Range
Tests if the last value in either range is one less than the first value of the other.
and(A) - Method in class uk.ipfreely.Address
Bitwise AND.
and(V4) - Method in class uk.ipfreely.V4
 
and(V6) - Method in class uk.ipfreely.V6
 

B

block(A, int) - Static method in class uk.ipfreely.sets.AddressSets
Creates Block from network address and mask size.
block(A, A) - Static method in class uk.ipfreely.sets.AddressSets
Creates a block from the given addresses which MUST form a valid CIDR block.
Block<A> - Interface in uk.ipfreely.sets
Range interface that forms RFC-4632 Classless Inter-domain Routing block of IP Addresses.
blocks() - Method in interface uk.ipfreely.sets.Range
Streams arbitrary range as valid CIDR blocks.

C

cidrNotation() - Method in interface uk.ipfreely.sets.Block
The block in CIDR notation like 192.168.100.0/24.
combine(Range<A>) - Method in interface uk.ipfreely.sets.Range
Combines two ranges into a single range using the least and greatest values from each.
compareTo(V4) - Method in class uk.ipfreely.V4
Useful for sorting.
compareTo(V6) - Method in class uk.ipfreely.V6
Useful for sorting.
contains(Address<?>) - Method in interface uk.ipfreely.sets.AddressSet
Tests if contains(Address) is true for any of the constituent AddressSet.ranges().
contains(Address<?>) - Method in interface uk.ipfreely.sets.Range
Tests argument is same Family and more than or equal to first() and less than or equal to last().
contiguous(Range<A>) - Method in interface uk.ipfreely.sets.Range
Tests if this range can create a contiguous range with another.
count(int) - Method in class uk.ipfreely.Subnets
The number of addresses for the number of bits in a CIDR notation mask.

D

divide(A) - Method in class uk.ipfreely.Address
Division.
divide(V4) - Method in class uk.ipfreely.V4
 
divide(V6) - Method in class uk.ipfreely.V6
 
doubleValue() - Method in class uk.ipfreely.Address
doubleValue() - Method in class uk.ipfreely.V4
 
doubleValue() - Method in class uk.ipfreely.V6
 

E

equals(Object) - Method in class uk.ipfreely.Address
Object equality.
equals(Object) - Method in interface uk.ipfreely.sets.AddressSet
Range Contract: other is Range instance and first() & last() are equal.
equals(Object) - Method in class uk.ipfreely.V4
 
equals(Object) - Method in class uk.ipfreely.V6
 

F

family() - Method in class uk.ipfreely.Address
Internet protocol family - V4 or V6.
family() - Method in class uk.ipfreely.Subnets
IP address family.
family() - Method in class uk.ipfreely.V4
 
family() - Method in class uk.ipfreely.V6
 
Family<A> - Class in uk.ipfreely
Address factory and utility type for IpV4 and IpV6 obtained via Family.v4() and Family.v6().
first() - Method in interface uk.ipfreely.sets.Range
Least element in the range.
from(Iterable<S>) - Static method in class uk.ipfreely.sets.AddressSets
Version of AddressSets.of(AddressSet[]) intended for standard collections.

H

hashCode() - Method in class uk.ipfreely.Address
Hash code.
hashCode() - Method in interface uk.ipfreely.sets.AddressSet
Range Contract: first().hashCode() * 31 + last().hashCode()
hashCode() - Method in class uk.ipfreely.V4
 
hashCode() - Method in class uk.ipfreely.V6
 
highBits() - Method in class uk.ipfreely.Address
Useful for efficient conversion.
highBits() - Method in class uk.ipfreely.V4
The high bits are out of range for IPv4.
highBits() - Method in class uk.ipfreely.V6
 

I

intersects(Range<A>) - Method in interface uk.ipfreely.sets.Range
Tests if there is any overlap in the address ranges.
iterator() - Method in interface uk.ipfreely.sets.Range
All addresses in the range.

L

last() - Method in interface uk.ipfreely.sets.Range
Greatest element in the range.
leadingZeros() - Method in class uk.ipfreely.Address
leadingZeros() - Method in class uk.ipfreely.V4
 
leadingZeros() - Method in class uk.ipfreely.V6
 
lowBits() - Method in class uk.ipfreely.Address
Useful for efficient conversion.
lowBits() - Method in class uk.ipfreely.V4
The IP address as n long between 0L and 0xFFFFFFFFL.
lowBits() - Method in class uk.ipfreely.V6
 

M

mask() - Method in interface uk.ipfreely.sets.Block
The CIDR mask as an IP address.
maskBits(A, A) - Method in class uk.ipfreely.Subnets
Calculates the mask bit size for an IP address CIDR block range.
masks() - Method in class uk.ipfreely.Subnets
All possible IP address masks for this family.
maskSize() - Method in interface uk.ipfreely.sets.Block
Mask size in bits as defined by CIDR notation.
max() - Method in class uk.ipfreely.Family
Maximum IP value.
min() - Method in class uk.ipfreely.Family
Zero.
mod(A) - Method in class uk.ipfreely.Address
Modulus.
mod(V4) - Method in class uk.ipfreely.V4
 
mod(V6) - Method in class uk.ipfreely.V6
 
multiply(A) - Method in class uk.ipfreely.Address
Multiplication with overflow.
multiply(V4) - Method in class uk.ipfreely.V4
 
multiply(V6) - Method in class uk.ipfreely.V6
 

N

next() - Method in class uk.ipfreely.Address
Returns the IP address incremented by one, with overflow.
not() - Method in class uk.ipfreely.Address
Bitwise NOT.
not() - Method in class uk.ipfreely.V4
 
not() - Method in class uk.ipfreely.V6
 

O

of(S...) - Static method in class uk.ipfreely.sets.AddressSets
Factory method for AddressSet.
or(A) - Method in class uk.ipfreely.Address
Bitwise OR.
or(V4) - Method in class uk.ipfreely.V4
 
or(V6) - Method in class uk.ipfreely.V6
 

P

parse(byte...) - Method in class uk.ipfreely.Family
Argument must be bitWidth() / 8 bytes in length.
parse(int) - Method in class uk.ipfreely.Family
Convenience method for creating Address from number.
parse(long, long) - Method in class uk.ipfreely.Family
IP address instantiation from primitives.
parse(CharSequence) - Method in class uk.ipfreely.Family
Parses an IP address string.
parse(BigInteger) - Method in class uk.ipfreely.Family
Enables the conversion from BigInteger to the Address type.
parseCidr(String) - Static method in class uk.ipfreely.sets.AddressSets
Parses a CIDR string form as defined by RFC4632.
parseCidr(Family<A>, String) - Static method in class uk.ipfreely.sets.AddressSets
As AddressSets.parseCidr(String) with version expectation.
ParseException - Exception Class in uk.ipfreely
Indicates the provided argument cannot be parsed to the expected type.
ParseException(String) - Constructor for exception class uk.ipfreely.ParseException
Constructor.
ParseException(Throwable) - Constructor for exception class uk.ipfreely.ParseException
Constructor.
prev() - Method in class uk.ipfreely.Address
Returns the IP address decremented by one, with underflow.

R

range(A, A) - Static method in class uk.ipfreely.sets.AddressSets
Creates Range instance.
Range<A> - Interface in uk.ipfreely.sets
AddressSet interface that forms contiguous range of one or more Addresses.
ranges() - Method in interface uk.ipfreely.sets.AddressSet
Constituent Ranges.
ranges() - Method in interface uk.ipfreely.sets.Range
 
regex() - Method in class uk.ipfreely.Family
Regular expression for detecting IP addresses in this family.

S

shift(int) - Method in class uk.ipfreely.Address
Bitwise shift.
shift(int) - Method in class uk.ipfreely.V4
 
shift(int) - Method in class uk.ipfreely.V6
 
size() - Method in interface uk.ipfreely.sets.AddressSet
Number of unique Addresses.
size() - Method in interface uk.ipfreely.sets.Block
Number of Addresses in block.
size() - Method in interface uk.ipfreely.sets.Range
Number of Addresses in range.
spliterator() - Method in interface uk.ipfreely.sets.Range
stream() - Method in interface uk.ipfreely.sets.Range
All addresses in the range.
subnets() - Method in class uk.ipfreely.Family
Subnet utilities.
subnets(int) - Method in interface uk.ipfreely.sets.Block
Divides the block into smaller subnets of given bit mask size.
Subnets<A> - Class in uk.ipfreely
Provides utility methods for working with RFC-4632 Classless Inter-domain Routing blocks of IP addresses for a given Family.
subtract(A) - Method in class uk.ipfreely.Address
Subtraction with underflow.
subtract(V4) - Method in class uk.ipfreely.V4
 
subtract(V6) - Method in class uk.ipfreely.V6
 

T

toBigInteger() - Method in class uk.ipfreely.Address
The address as a BigInteger.
toBigInteger() - Method in class uk.ipfreely.V4
 
toBigInteger() - Method in class uk.ipfreely.V6
 
toBytes() - Method in class uk.ipfreely.Address
The address as bytes of length Family.width() / Byte.SIZE.
toBytes() - Method in class uk.ipfreely.V4
 
toBytes() - Method in class uk.ipfreely.V6
 
toString() - Method in class uk.ipfreely.Address
String form amenable to parsers.
toString() - Method in class uk.ipfreely.Family
Informational.
toString() - Method in class uk.ipfreely.Subnets
Informational.
toString() - Method in class uk.ipfreely.V4
IPv4 address in dotted quad notation.
toString() - Method in class uk.ipfreely.V6
trailingZeros() - Method in class uk.ipfreely.Address
trailingZeros() - Method in class uk.ipfreely.V4
 
trailingZeros() - Method in class uk.ipfreely.V6
 
type() - Method in class uk.ipfreely.Family
IP address type.

U

uk.ipfreely - package uk.ipfreely
Generic IP addresses as numeric types with arithmetic and bitwise operations.
uk.ipfreely.sets - package uk.ipfreely.sets
Specialized IP address collection types capable of representing entire address ranges or subsets thereof.
unknown(byte...) - Static method in class uk.ipfreely.Family
Uses array length to detect IP address family and calls Family.parse(byte...).
unknown(CharSequence) - Static method in class uk.ipfreely.Family
Uses heuristics to detect IP address family and calls Family.parse(CharSequence).
Usage Hints - Search tag in class uk.ipfreely.Address
Section

V

v4() - Static method in class uk.ipfreely.Family
IPv4.
V4 - Class in uk.ipfreely
Immutable IPv4 Address and 32-bit unsigned integer value.
v6() - Static method in class uk.ipfreely.Family
IPv6.
V6 - Class in uk.ipfreely
Immutable IPv6 Address and 128-bit unsigned integer value.

W

width() - Method in class uk.ipfreely.Family
Width of the IP address type in bits.

X

xor(A) - Method in class uk.ipfreely.Address
Bitwise exclusive OR.
xor(V4) - Method in class uk.ipfreely.V4
 
xor(V6) - Method in class uk.ipfreely.V6
 
A B C D E F H I L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Serialized Form