IPAddress Java Library

To use IPAddress in your Java project, add the following dependency to your Maven configuration. The library is available in Maven Central.

Maven Coordinates:

• Group ID: com.github.seancfoley
• Artifact ID: ipaddress

Note: For OSGI environments, the bundle ID is com.github.seancfoley.ipaddress (available since version 5.3.1).

<!-- Example Maven dependency structure -->
<dependency>
    <groupId>com.github.seancfoley</groupId>
    <artifactId>ipaddress</artifactId>
    <version>5.6.2</version>
</dependency>

In Groovy, you can parse IP strings using IPAddressString. You can use standard try-catch blocks for error handling or check for null when using the .getAddress() method.

// Using exceptions
def addressStr = new IPAddressString('a:b:c:d:e:f:1.2.3.4')
try {
	def address = addressStr.toAddress()
} catch (AddressStringException e) {
	// handle error
}

// Checking for null
def subnetStr = new IPAddressString('108.30-31.*.*')
def subnet = subnetStr.getAddress()
if(subnet != null) {
	// use address
}

In Kotlin, you can parse IP strings using IPAddressString. You can either use explicit exception handling for invalid formats or use nullable types for a more idiomatic Kotlin approach.

Using Exceptions:

val ipv6Str = "a:b:c:d::a:b/64"
try {
	val ipv6Addr = IPAddressString(ipv6Str).toAddress()
} catch(e: AddressStringException) {
	// handle error
}

Using Nullable Types:

val ipv6v4Str = "a:b:c:d:e:f:1.2.3.4/112"
val ipv6v4AddressStr = IPAddressString(ipv6v4Str)
val ipAddr: IPAddress? = ipv6v4AddressStr.address
// ipAddr will be null if the string is invalid

val ipv6Str = "a:b:c:d::a:b/64"
try {
	val ipv6AddressStr = IPAddressString(ipv6Str)
	val ipv6Addr = ipv6AddressStr.toAddress()
	// use address
	println(ipv6Addr) // a:b:c:d::a:b/64
} catch(e: AddressStringException) {
	println(e.message)
}

In Scala, use IPAddressString wrapped in a Try block to handle potential AddressStringException errors safely using pattern matching.

import scala.util.{Failure, Success, Try}

val addressStr = new IPAddressString("a:b:c:d::/64")
Try(addressStr.toAddress) match {
    case Success(userInfo) =>
        // use address
    case Failure(exception: AddressStringException) =>
        // handle improperly formatted address string
}

Use IPAddressString to convert string representations of IP addresses or subnets (including CIDR notation) into IPAddress objects. This method throws an AddressStringException if the string format is invalid.

String ipv6Str = "::/64";
String ipv4Str = "1.2.255.4/255.255.0.0";
try {
	IPAddress ipv6Address = new IPAddressString(ipv6Str).toAddress();
	IPAddress ipv4Address = new IPAddressString(ipv4Str).toAddress();
    // use addresses
} catch (AddressStringException e) {
	// handle improperly formatted address string
}

When working with the parsing internals, IPAddressParseData provides methods to inspect the characteristics of the parsed string:

• Version Detection: Use isProvidingIPv4() and isProvidingIPv6() to determine the detected IP version.
• Zoning and Qualifiers: Use isZoned() to check for zone information and getQualifier() to retrieve the ParsedHostIdentifierStringQualifier.
• Compression: Use isCompressed() to check if the address uses compression (like :: in IPv6).
• Special Formats: Use isProvidingBase85IPv6() to detect Base85 encoded IPv6 addresses or isProvidingMixedIPv6() for mixed IPv4/IPv6 formats.

For MAC address parsing, MACAddressParseData allows you to inspect the detected format and structure:

• getFormat(): Returns a MACFormat enum indicating the separator used (e.g., DASHED, COLON_DELIMITED, DOTTED, or SPACE_DELIMITED).
• isDoubleSegment(): Indicates if the MAC address uses double segments.
• isExtended(): Indicates if the address is an extended 64-bit identifier.