com.ip2location

Class IPTools

java.lang.Object

com.ip2location.IPTools

public class IPTools
extends Object

This class contains IP address related tools.

Example usage scenarios:

• Checks if the IP address is an IPv4
• Checks if the IP address is an IPv6
• Converts IPv4 to decimal
• Converts IPv6 to decimal
• Converts decimal to IPv4
• Converts decimal to IPv6
• Returns compressed form of IPv6
• Returns expanded form of IPv6
• Converts IPv4 range to CIDR
• Converts IPv6 range to CIDR
• Converts CIDR to IPv4 range
• Converts CIDR to IPv6 range

Copyright (c) 2002-2023 IP2Location.com

Version:

8.11.1

Author:

IP2Location.com

Constructor Summary

Constructors

Constructor and Description
IPTools()

Method Summary

Modifier and Type	Method and Description
String[]	CIDRToIPv4(String CIDR) This function returns the IPv4 range for a CIDR.
String[]	CIDRToIPv6(String CIDR) This function returns the IPv6 range for a CIDR.
String	CompressIPv6(String IPAddress) This function returns the compressed form of the IPv6.
String	DecimalToIPv4(BigInteger IPNum) This function converts IP number to IPv4.
String	DecimalToIPv6(BigInteger IPNum) This function converts IP number to IPv6.
String	ExpandIPv6(String IPAddress) This function returns the expanded form of the IPv6.
List<String>	IPv4ToCIDR(String IPFrom, String IPTo) This function returns the CIDR for an IPv4 range.
BigInteger	IPv4ToDecimal(String IPAddress) This function converts IPv4 to IP number.
List<String>	IPv6ToCIDR(String IPFrom, String IPTo) This function returns the CIDR for an IPv6 range.
BigInteger	IPv6ToDecimal(String IPAddress) This function converts IPv6 to IP number.
boolean	IsIPv4(String IPAddress) This function checks if the string contains an IPv4 address.
boolean	IsIPv6(String IPAddress) This function checks if the string contains an IPv6 address.

Methods inherited from class java.lang.Object

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

Constructor Detail

IPTools

public IPTools()

Method Detail

IsIPv4

public boolean IsIPv4(String IPAddress)

This function checks if the string contains an IPv4 address.

Parameters:

IPAddress - IP Address to check

Returns:

Boolean

IsIPv6

public boolean IsIPv6(String IPAddress)

This function checks if the string contains an IPv6 address.

Parameters:

IPAddress - IP Address to check

Returns:

Boolean

IPv4ToDecimal

public BigInteger IPv4ToDecimal(String IPAddress)

This function converts IPv4 to IP number.

Parameters:

IPAddress - IP Address you wish to convert

Returns:

BigInteger

IPv6ToDecimal

public BigInteger IPv6ToDecimal(String IPAddress)

This function converts IPv6 to IP number.

Parameters:

IPAddress - IP Address you wish to convert

Returns:

BigInteger

DecimalToIPv4

public String DecimalToIPv4(BigInteger IPNum)
                     throws UnknownHostException

This function converts IP number to IPv4.

Parameters:

IPNum - IP number you wish to convert

Returns:

String

Throws:

UnknownHostException - If unable to convert byte array to IP address

DecimalToIPv6

public String DecimalToIPv6(BigInteger IPNum)
                     throws UnknownHostException

This function converts IP number to IPv6.

Parameters:

IPNum - IP number you wish to convert

Returns:

String

Throws:

UnknownHostException - If unable to convert byte array to IP address

CompressIPv6

public String CompressIPv6(String IPAddress)

This function returns the compressed form of the IPv6.

Parameters:

IPAddress - IP Address you wish to compress

Returns:

String

ExpandIPv6

public String ExpandIPv6(String IPAddress)

This function returns the expanded form of the IPv6.

Parameters:

IPAddress - IP Address you wish to expand

Returns:

String

IPv4ToCIDR

public List<String> IPv4ToCIDR(String IPFrom,
                               String IPTo)
                        throws UnknownHostException

This function returns the CIDR for an IPv4 range.

Parameters:

IPFrom - Starting IP of the range

IPTo - Ending IP of the range

Returns:

List of strings

Throws:

UnknownHostException - If unable to convert byte array to IP address

IPv6ToCIDR

public List<String> IPv6ToCIDR(String IPFrom,
                               String IPTo)
                        throws UnknownHostException

This function returns the CIDR for an IPv6 range.

Parameters:

IPFrom - Starting IP of the range

IPTo - Ending IP of the range

Returns:

List of strings

Throws:

UnknownHostException - If unable to convert byte array to IP address

CIDRToIPv4

public String[] CIDRToIPv4(String CIDR)
                    throws UnknownHostException

This function returns the IPv4 range for a CIDR.

Parameters:

CIDR - CIDR address to convert to range

Returns:

Array of strings

Throws:

UnknownHostException - If unable to convert byte array to IP address

CIDRToIPv6

public String[] CIDRToIPv6(String CIDR)
                    throws UnknownHostException

This function returns the IPv6 range for a CIDR.

Parameters:

CIDR - CIDR address to convert to range

Returns:

Array of strings

Throws:

UnknownHostException - If unable to convert byte array to IP address