JarCasting
JarCasting JarCasting

commons-ip-math

A project to make it easier to work with Internet resources, such as IPv4, IPv6 and AS numbers.

License

License
GroupId

GroupId

com.github.jgonian
ArtifactId

ArtifactId

commons-ip-math
Last Version

Last Version

1.32
Release Date

Release Date
Type

Type

jar
Description

Description

commons-ip-math
A project to make it easier to work with Internet resources, such as IPv4, IPv6 and AS numbers.

Download commons-ip-math

Filename Size
commons-ip-math-1.32.pom
commons-ip-math-1.32.jar 44 KB
commons-ip-math-1.32-sources.jar 34 KB
commons-ip-math-1.32-javadoc.jar 174 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.jgonian/commons-ip-math/ -->
<dependency>
    <groupId>com.github.jgonian</groupId>
    <artifactId>commons-ip-math</artifactId>
    <version>1.32</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.jgonian/commons-ip-math/
implementation 'com.github.jgonian:commons-ip-math:1.32'
// https://jarcasting.com/artifacts/com.github.jgonian/commons-ip-math/
implementation ("com.github.jgonian:commons-ip-math:1.32")
'com.github.jgonian:commons-ip-math:jar:1.32'
<dependency org="com.github.jgonian" name="commons-ip-math" rev="1.32">
  <artifact name="commons-ip-math" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.jgonian', module='commons-ip-math', version='1.32')
)
libraryDependencies += "com.github.jgonian" % "commons-ip-math" % "1.32"
[com.github.jgonian/commons-ip-math "1.32"]

Dependencies

test (2)

Group / Artifact Type Version
junit : junit jar 4.12
nl.jqno.equalsverifier : equalsverifier jar 1.7.5

Project Modules

There are no modules declared in this project.

Build Status Coverage Status Maven Central

Commons IP Math

Description

This library contains a representation of internet resources:

  • IPv4 and IPv6 addresses and ranges
  • Autonomous System Numbers (ASNs)

It provides a rich, type-safe API for dealing with the most common operations performed with IP resources, such as: parsing, printing in several notations, checking if ranges are overlapping or can be merged, etc.

It also provides Comparators, Set collections and other utilities for working with IP ranges and Prefixes.

Dependency Information

Maven:

<dependency>
    <groupId>com.github.jgonian</groupId>
    <artifactId>commons-ip-math</artifactId>
    <version>${version}</version>
</dependency>

SBT:

libraryDependencies += "com.github.jgonian" % "commons-ip-math" % s"${version}"

For the latest released version, check the Central Repository.

Examples

IPv4 addresses

Ipv4 start = Ipv4.of("192.168.0.0");
Ipv4 end = Ipv4.of("192.168.0.255");

// Fluent API for creating new instances
Ipv4Range a = Ipv4Range.from(start).to(end);
Ipv4Range b = Ipv4Range.from("192.168.0.0").andPrefixLength(24);
Ipv4Range c = Ipv4Range.parse("192.168.0.0/24");
Ipv4Range d = Ipv4Range.parse("192.168.1.0/24");

a.equals(b);        // true
a.isEmpty();        // false
a.size();           // 256
a.contains(b);      // true
a.overlaps(d);      // false
a.isConsecutive(d); // true
a.merge(d);         // 192.168.0.0/23

IPv6 addresses

Ipv6 start = Ipv6.of("2001:db8:0:0:0:0:0:0");       // 2001:db8::
Ipv6 end   = IPv6.of("2001:db8:0:0:0:0:0:ffff");    // 2001:db8::ffff

// Fluent API for creating new instances
Ipv6Range a = Ipv6Range.from(start).to(end);
Ipv6Range b = Ipv6Range.from(start).andPrefixLength(112);
Ipv6Range c = Ipv6Range.parse("2001:db8::/112");
Ipv6Range d = Ipv6Range.parse("2001:db8::1:0/112");

a.equals(b);        // true
a.isEmpty();        // false
a.size();           // 65536
a.contains(b);      // true
a.overlaps(d);      // false
a.isConsecutive(d); // true
a.merge(d);         // 2001:db8::/111

Printing of IPv6 addresses complies with RFC 5952.

Autonomous System Numbers (ASNs)

Asn.of("AS65546");  // AS65546
Asn.of(65546l);     // AS65546
Asn.of("1.10");     // AS65546

Asn.of("AS65546").is32Bit() // true

Parsing of AS numbers complies with RFC 5396.

Sets

SortedResourceSet<Ipv4, Ipv4Range> set = new SortedResourceSet<Ipv4, Ipv4Range>();
set.add(Ipv4Range.parse("192.168.0.0/16"));
set.add(Ipv4Range.parse("10.0.0.0-10.0.0.253"));
set.add(Ipv4.of("10.0.0.254"));
set.add(Ipv4.of("10.0.0.255"));
System.out.println(set);           // [10.0.0.0/24, 192.168.0.0/16]

Comparators

Ipv6Range a = Ipv6Range.parse("2001::/64");
Ipv6Range b = Ipv6Range.parse("2001::/65");
SizeComparator.<Ipv6Range>get().compare(a, b);  // 1

Iterable ranges

for (Ipv4 ip : Ipv4Range.parse("10.0.0.0/30")) {
    System.out.println(ip);
}
// will print:
// 10.0.0.0
// 10.0.0.1
// 10.0.0.2
// 10.0.0.3

and more

License

The commons-ip-math is released under the MIT license.

Acknowledgements

The project started as a fork of IP Resource and it has been evolved to the extent that most of the logic was rewritten. Special thanks for the inspiration to many contributors of the IP resource library and in particular Erik Rozendaal, Szabolcs Andrasi, Oleg Muravskiy, Johan Ählen and Katie Petrusha.

Versions

Version
1.32
1.31
1.30