inet.ipaddr

Class IPAddress

    • Method Detail

      • toHostName

        public HostName toHostName()
        If this address was resolved from a host, returns that host. Otherwise, does a reverse name lookup.

      • toCanonicalHostName

        public HostName toCanonicalHostName()
        Does a reverse name lookup to get the canonical host name.

      • getMaxSegmentValue

        public int getMaxSegmentValue()
        Specified by:
        getMaxSegmentValue in class Address
        Returns:
        the maximum possible segment value for this type of address. Note this is not the maximum value of the segments in this specific address.

      • getNonZeroHostCount

        public java.math.BigInteger getNonZeroHostCount()
        Description copied from interface: IPAddressSegmentSeries
        Gets the count of single value series that this series may represent. If excludeZeroHosts is true, the count excludes series whose host is zero. If this address series has no range of values, then there is only one such address. If this has no CIDR network prefix length, then it is equivalent to AddressItem.getCount().
        Specified by:
        getNonZeroHostCount in interface IPAddressSegmentSeries
        Returns:

      • getBytesPerSegment

        public int getBytesPerSegment()
        Description copied from interface: AddressSegmentSeries
        Returns the number of bytes comprising each segment in this series. Segments in the same series are equal length.
        Specified by:
        getBytesPerSegment in interface AddressSegmentSeries
        Returns:

      • getBitsPerSegment

        public int getBitsPerSegment()
        Description copied from interface: AddressSegmentSeries
        Returns the number of bits comprising each segment in this series. Segments in the same series are equal length.
        Specified by:
        getBitsPerSegment in interface AddressSegmentSeries
        Returns:

      • increment

        public abstract IPAddress increment(long increment)
        Description copied from interface: AddressSegmentSeries
        Returns the series from the subnet that is the given increment upwards into the subnet range, or if the given increment is negative the given increment downwards into the subnet range, or if this is just an individual series, it simply adds the increment to this. If the increment is 0, then this series is returned.

        If the subnet has multiple values and the increment exceeds the subnet size, then the amount by which is exceeds the size is added to the upper series of the range (the final iterator value) or is subtracted from the lower series of the range (the first iterator value) if negative.

        If the subnet is just a single address values, the series is simply incremented by the given value, positive or negative.

        If a subnet has multiple values, a positive increment value is equivalent to the same number of values from the iterator. For instance, a increment of 1 is value 1 from the iterator, an increment of 2 is the second value from the iterator, and so on. A negative increment is equivalent to the same number of values preceding the upper bound of the iterator. For instance, an increment of -1 is the last value from the iterator, and increment of -2 is the second last value, and so on.

        Therefore, to get the series just above the highest series of the subnet, use an increment of size:count > 1 ? count + 1 : 1 where count is the subnet size. To get the series just below the lowest series of the subnet, use an increment of size:-(count > 1 ? count + 1 : 1) where count is the subnet size.

        Specified by:
        increment in interface AddressSegmentSeries
        Specified by:
        increment in interface IPAddressSegmentSeries
        Specified by:
        increment in class Address
        Returns:

      • isIPv4

        public boolean isIPv4()

      • isIPv6

        public boolean isIPv6()

      • isIPv4Convertible

        public abstract boolean isIPv4Convertible()
        Determines whether this address can be converted to IPv4, if not IPv4 already. Override this method to convert in your own way. If IPv6, the default behaviour is to convert by IPv4 mapping, see IPv6Address.isIPv4Mapped() You should also override toIPv4() to match the conversion. This method returns true for all IPv4 addresses.
        Returns:

      • isIPv6Convertible

        public abstract boolean isIPv6Convertible()
        Determines whether an address can be converted to IPv6, if not IPv6 already. Override this method to convert in your own way. The default behaviour is to convert by IPv4 mapping, see IPv4Address.getIPv4MappedAddress() You should also override toIPv6() to match the conversion. This method returns true for all IPv6 addresses.
        Returns:

      • isLinkLocal

        public abstract boolean isLinkLocal()
        Returns whether the address is link local, whether unicast or multicast.
        See Also:
        InetAddress.isLinkLocalAddress()

      • isLocal

        public abstract boolean isLocal()
        Returns true if the address is link local, site local, organization local, administered locally, or unspecified. This includes both unicast and multicast.
        Specified by:
        isLocal in class Address
        Returns:

      • isUnspecified

        public boolean isUnspecified()
        The unspecified address is the address that is all zeros.
        Returns:

      • isAnyLocal

        public boolean isAnyLocal()
        Returns whether this address is the address which binds to any address on the local host. This is the address that has the value of 0, aka the unspecfied address.
        See Also:
        InetAddress.isAnyLocalAddress()

      • isLoopback

        public abstract boolean isLoopback()
        See Also:
        InetAddress.isLoopbackAddress()

      • toUpperInetAddress

        public java.net.InetAddress toUpperInetAddress()
        Converts the highest value of this address to an InetAddress. If this consists of just a single address and not a subnet, this is equivalent to toInetAddress()

      • toInetAddress

        public java.net.InetAddress toInetAddress()
        Converts the lowest value of this address to an InetAddress

      • isSameAddress

        public boolean isSameAddress(IPAddress other)

      • matchesWithMask

        public boolean matchesWithMask(IPAddress other,
                               IPAddress mask)
        Applies the mask to this address and then compares values with the given address
        Parameters:
        mask -
        other -
        Returns:

      • toFullString

        public java.lang.String toFullString()
        This produces a string with no compressed segments and all segments of full length, which is 4 characters for IPv6 segments and 3 characters for IPv4 segments. Each address has a unique full string, not counting CIDR the prefix, which can give two equal addresses different strings.
        Specified by:
        toFullString in interface IPAddressSegmentSeries

      • toSubnetString

        public java.lang.String toSubnetString()
        Produces a consistent subnet string that looks like 1.2.*.* or 1:2::/16 In the case of IPv4, this means that wildcards are used instead of a network prefix when a network prefix has been supplied. In the case of IPv6, when a network prefix has been supplied, the prefix will be shown and the host section will be compressed with ::.
        Specified by:
        toSubnetString in interface IPAddressSegmentSeries

      • toNormalizedWildcardString

        public java.lang.String toNormalizedWildcardString()
        This produces a string similar to the normalized string but avoids the CIDR prefix. CIDR addresses will be shown with wildcards and ranges instead of using the CIDR prefix notation.
        Specified by:
        toNormalizedWildcardString in interface IPAddressSegmentSeries

      • toCanonicalWildcardString

        public java.lang.String toCanonicalWildcardString()
        This produces a string similar to the canonical string but avoids the CIDR prefix. Addresses with a network prefix length will be shown with wildcards and ranges instead of using the CIDR prefix length notation. IPv6 addresses will be compressed according to the canonical representation.
        Specified by:
        toCanonicalWildcardString in interface IPAddressSegmentSeries

      • toCompressedWildcardString

        public java.lang.String toCompressedWildcardString()
        This is similar to toNormalizedWildcardString, avoiding the CIDR prefix, but with compression as well.
        Specified by:
        toCompressedWildcardString in interface IPAddressSegmentSeries

      • toPrefixLengthString

        public java.lang.String toPrefixLengthString()
        Returns a string with a CIDR network prefix length if this address has a network prefix length. For IPv6, the host section will be compressed with ::, for IPv4 the host section will be zeros.
        Specified by:
        toPrefixLengthString in interface IPAddressSegmentSeries
        Returns:

      • toConvertedString

        public java.lang.String toConvertedString()
        Returns a mixed string if it represents a convertible IPv4 address, returns the normalized string otherwise.
        Returns:

      • toUNCHostName

        public abstract java.lang.String toUNCHostName()
        Generates the Microsoft UNC path component for this address
        Returns:

      • toReverseDNSLookupString

        public java.lang.String toReverseDNSLookupString()
        Generates the reverse DNS lookup string

        For 8.255.4.4 it is 4.4.255.8.in-addr.arpa
        For 2001:db8::567:89ab it is b.a.9.8.7.6.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa

        Specified by:
        toReverseDNSLookupString in interface IPAddressSegmentSeries
        Returns:
        Throws:
        IncompatibleAddressException - if this address is a subnet

      • toBinaryString

        public java.lang.String toBinaryString()
        Writes this address as a single binary value with always the exact same number of characters

        If this section represents a range of values not corresponding to a prefix, then this is printed as a range of two hex values.

        Specified by:
        toBinaryString in interface IPAddressSegmentSeries

      • toOctalString

        public java.lang.String toOctalString(boolean with0Prefix)
        Writes this address as a single octal value with always the exact same number of characters, with or without a preceding 0 prefix.

        If this section represents a range of values not corresponding to a prefix, then this is printed as a range of two hex values.

        Specified by:
        toOctalString in interface IPAddressSegmentSeries

      • toNormalizedString

        public java.lang.String toNormalizedString(IPAddressSection.IPStringOptions params)
        Constructs a string representing this address according to the given parameters
        Specified by:
        toNormalizedString in interface IPAddressSegmentSeries
        Parameters:
        params - the parameters for the address string
        Returns:
        Throws:
        IncompatibleAddressException - for cases in which the requested string cannot be produced, which can generally only occur with specific strings from specific subnets.

      • toStandardStrings

        public java.lang.String[] toStandardStrings()
        Returns at most a few dozen string representations: -mixed (1:2:3:4:5:6:1.2.3.4) -full compressions (a:0:b:c:d:0:e:f or a::b:c:d:0:e:f or a:0:b:c:d::e:f) -full leading zeros (000a:0000:000b:000c:000d:0000:000e:000f) -all uppercase and all lowercase (a::a can be A::A) -combinations thereof
        Returns:

      • toAllStrings

        public java.lang.String[] toAllStrings()
        Produces almost all possible string variations

        Use this method with care... a single IPv6 address can have thousands of string representations.

        Examples:

        • "::" has 1297 such variations, but only 9 are considered standard
        • "a:b:c:0:d:e:f:1" has 1920 variations, but only 12 are standard

        Variations included in this method:

        • all standard variations from toStandardStrings()
        • adding a variable number of leading zeros (::a can be ::0a, ::00a, ::000a)
        • choosing any number of zero-segments to compress (:: can be 0:0:0::0:0)
        • mixed representation of all variations (1:2:3:4:5:6:1.2.3.4)
        • all uppercase and all lowercase (a::a can be A::A)
        • all combinations of such variations
        Variations omitted from this method: mixed case of a-f, which you can easily handle yourself with String.equalsIgnoreCase

        Returns:
        the strings

      • toStrings

        public java.lang.String[] toStrings(IPAddressSection.IPStringBuilderOptions options)
        Rather than using toAllStrings or StandardStrings, you can use this method to customize the list of strings produced for this address

      • toAddressString

        public IPAddressString toAddressString()
        Generates an IPAddressString object for this IPAddress object.

        This same IPAddress object can be retrieved from the resulting IPAddressString object using IPAddressString.getAddress()

        In general, users are intended to create IPAddress objects from IPAddressString objects, while the reverse direction is generally not all that useful.

        However, the reverse direction can be useful under certain circumstances.

        Not all IPAddressString objects can be converted to IPAddress objects, as is the case with IPAddressString objects corresponding to the types IPType.INVALID and IPType.EMPTY.

        Not all IPAddressString objects can be converted to IPAddress objects without specifying the IP version, as is the case with IPAddressString objects corresponding to the types IPType.PREFIX and IPType.ALL.

        So in the event you wish to store a collection of IPAddress objects with a collection of IPAddressString objects, and not all the IPAddressString objects can be converted to IPAddress objects, then you may wish to use a collection of only IPAddressString objects, in which case this method is useful.

        Overrides:
        toAddressString in class Address
        Returns:
        an IPAddressString object for this IPAddress.

      • toDelimitedSQLStrs

        public static java.lang.String toDelimitedSQLStrs(java.lang.String[] strs)

      • getNetworkPrefixLength

        public java.lang.Integer getNetworkPrefixLength()
        Description copied from interface: IPAddressSegmentSeries
        Returns the CIDR network prefix length of the series, or null if the series has no associated prefix length.

        Equivalent to AddressDivisionSeries.getPrefixLength(), which is the more general concept of set of address series that share the same set of leading bits. For IP addresses and sections the prefix length and the CIDR network prefix length are the same thing.

        For IP addresses and sections each individual segment has an associated prefix length which is determine by the network prefix length. The segment prefix lengths follow the pattern: null, null, ...., null, x, 0, 0, ..., 0

        For instance, an IPv4 address 1.2.3.4/16 has the network prefix length 16. The segment prefix lengths are [null, 8, 0, 0] The segment prefix lengths of 1.2.3.4/22 are [null, null, 6, 0]

        Specified by:
        getNetworkPrefixLength in interface IPAddressSegmentSeries
        Returns:

      • includesZeroHost

        public boolean includesZeroHost()
        Description copied from interface: IPAddressSegmentSeries
        Returns whether the series has a host of zero. If the series has no prefix length, or the prefix length matches the bit count, then returns false. Otherwise, it checks whether all bits past the prefix are zero.
        Specified by:
        includesZeroHost in interface IPAddressSegmentSeries
        Returns:

      • toZeroHost

        public abstract IPAddress toZeroHost(int prefixLength)
        Description copied from interface: IPAddressSegmentSeries
        Produces the series with host values of 0 for the given prefix length.

        If this series has the same prefix length, then the resulting series will too, otherwise the resulting series will have no prefix length.

        This is nearly equivalent to doing the mask (bitwise conjunction) of this address series with the network mask for the given prefix length, but without the possibility of IncompatibleAddressException that can occur when applying a mask to a range of values. Instead, in this case, if the resulting series has a range of values, then the resulting series range boundaries will have host values of 0, but not necessarily the intervening values.

        For instance, you can get the network address for a subnet of prefix length 16 as follows: String addrStr = "1.2.3.4"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress networkAddress = address.toZeroHost(16); //1.2.0.0

        Specified by:
        toZeroHost in interface IPAddressSegmentSeries
        Returns:

      • toMaxHost

        public abstract IPAddress toMaxHost(int prefixLength)
        Description copied from interface: IPAddressSegmentSeries
        Produces the series with host values of all one bits for the given prefix length.

        If this series has the same prefix length, then the resulting series will too, otherwise the resulting series will have no prefix length.

        This is nearly equivalent to doing the bitwise or (bitwise disjunction) of this address series with the network mask for the given prefix length, but without the possibility of IncompatibleAddressException that can occur when applying a mask to a range of values. Instead, in this case, if the resulting series has a range of values, then the resulting series range boundaries will have host values of all ones, but not necessarily the intervening values.

        For instance, you can get the broadcast address for a subnet of prefix length 16 as follows: String addrStr = "1.2.3.4"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress broadcastAddress = address.toMaxHost(16); //1.2.255.255

        Specified by:
        toMaxHost in interface IPAddressSegmentSeries
        Returns:

      • includesMaxHost

        public boolean includesMaxHost()
        Description copied from interface: IPAddressSegmentSeries
        Returns whether the series has a host of all ones. If the series has no prefix length, or the prefix length matches the bit count, then returns false. Otherwise, it checks whether all bits past the prefix are ones.
        Specified by:
        includesMaxHost in interface IPAddressSegmentSeries
        Returns:

      • isSingleNetwork

        public boolean isSingleNetwork()
        Returns true if the network section of the address spans just a single value

        For example, return true for 1.2.3.4/16 and false for 1.2-3.3.4/16

      • toPrefixBlock

        public abstract IPAddress toPrefixBlock()
        Returns the subnet associated with the prefix length of this address. If this address has no prefix length, this address is returned.

        For example, if the address is 1.2.3.4/16 it returns the subnet 1.2.*.* /16

        Specified by:
        toPrefixBlock in interface AddressSegmentSeries
        Specified by:
        toPrefixBlock in interface IPAddressSegmentSeries
        Specified by:
        toPrefixBlock in class Address
        Returns:
        the block of address series for the prefix length

      • getBlockMaskPrefixLength

        public java.lang.Integer getBlockMaskPrefixLength(boolean network)
        If this address is equivalent to the mask for a CIDR prefix block, it returns that prefix length. Otherwise, it returns null. A CIDR network mask is all 1s in the network section and then all 0s in the host section. A CIDR host mask is all 0s in the network section and then all 1s in the host section. The prefix is the length of the network section. Also, keep in mind that the prefix length returned by this method is not equivalent to the prefix length used to construct this object. The prefix length used to construct indicates the network and host portion of this address. The prefix length returned here indicates the whether the value of this address can be used as a mask for the network and host portion of any other address. Therefore the two values can be different values, or one can be null while the other is not.
        Parameters:
        network - whether to check if we are a network mask or a host mask
        Returns:
        the prefix length corresponding to this mask, or null if there is no such prefix length

      • spanWithPrefixBlocks

        public abstract IPAddress[] spanWithPrefixBlocks(IPAddress other)
                                          throws AddressConversionException
        Produces the list of prefix block subnets that span from this series to the given series.

        If the other address is a different version than this, then the default conversion is applied first using toIPv4() or toIPv6()

        The resulting array is sorted from lowest address value to highest, regardless of the size of each prefix block.

        Parameters:
        other -
        Returns:
        Throws:
        AddressConversionException

      • mergePrefixBlocks

        public abstract IPAddress[] mergePrefixBlocks(IPAddress... addresses)
                                       throws AddressConversionException
        Merges this with the list of addresses to produce the smallest list of prefix blocks

        If any other address in the list is a different version than this, then the default conversion is applied first using toIPv4() or toIPv6(), which can result in AddressConversionException

        The result is sorted from single address to smallest blocks to largest blocks.

        Parameters:
        addresses - the addresses to merge with this
        Returns:
        Throws:
        AddressConversionException

      • intersect

        public abstract IPAddress intersect(IPAddress other)
                             throws AddressConversionException
        Produces the subnet whose addresses are found in both this and the given subnet argument.

        This is also known as the conjunction of the two sets of addresses.

        If the address is not the same version, the default conversion will be applied using toIPv4() or toIPv6(), and it that fails, AddressConversionException will be thrown.

        Parameters:
        other -
        Returns:
        the subnet containing the addresses found in both this and the given subnet
        Throws:
        AddressConversionException - if the address argument could not be converted to the same address version as this

      • subtract

        public abstract IPAddress[] subtract(IPAddress other)
                              throws AddressConversionException
        Subtract the given subnet from this subnet, returning an array of subnets for the result (the subnets will not be contiguous so an array is required).

        Computes the subnet difference, the set of addresses in this address subnet but not in the provided subnet. This is also known as the relative complement of the given argument in this subnet.

        If the address is not the same version, the default conversion will be applied using toIPv4() or toIPv6(), and it that fails, AddressConversionException will be thrown.

        Parameters:
        other -
        Returns:
        the difference
        Throws:
        AddressConversionException - if the address argument could not be converted to the same address version as this

      • mask

        public abstract IPAddress mask(IPAddress mask,
                               boolean retainPrefix)
                        throws AddressConversionException,
                               IncompatibleAddressException
        Applies the given mask to all addresses represented by this IPAddress. The mask is applied to all individual addresses. Any existing prefix length is removed beforehand. If the retainPrefix argument is true, then the existing prefix length will be applied to the result.

        If the mask is a different version than this, then the default conversion is applied first using toIPv4() or toIPv6()

        If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException is thrown.

        Parameters:
        mask -
        Returns:
        Throws:
        IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
        AddressConversionException - if the address argument could not be converted to the same address version as this

      • maskNetwork

        public abstract IPAddress maskNetwork(IPAddress mask,
                                      int networkPrefixLength)
                               throws AddressConversionException,
                                      IncompatibleAddressException
        Applies the given mask to all addresses represented by this IPAddress while also applying the given prefix length at the same time.

        Any existing prefix length is removed as the mask and new prefix length is applied to all individual addresses.

        If the mask is a different version than this, then the default conversion is applied first using toIPv4() or toIPv6()

        If this represents multiple addresses, and applying the mask to all addresses creates a set of addresses that cannot be represented as a contiguous range within each segment, then IncompatibleAddressException is thrown.

        Throws:
        IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
        AddressConversionException - if the address argument could not be converted to the same address version as this

      • bitwiseOr

        public abstract IPAddress bitwiseOr(IPAddress mask,
                                    boolean retainPrefix)
                             throws AddressConversionException,
                                    IncompatibleAddressException
        Does the bitwise disjunction with this address. Useful when subnetting.

        The mask is applied to all individual addresses, similar to how the method mask(IPAddress, boolean) applies the bitwise conjunction. Any existing prefix length is removed beforehand. If the retainPrefix argument is true, then the existing prefix length will be applied to the result.

        If the mask is a different version than this, then the default conversion is applied first using toIPv4() or toIPv6()

        If you wish to mask a portion of the network, use bitwiseOrNetwork(IPAddress, int)

        For instance, you can get the broadcast address for a subnet as follows: String addrStr = "1.2.3.4/16"; IPAddress address = new IPAddressString(addrStr).getAddress(); IPAddress hostMask = address.getNetwork().getHostMask(address.getNetworkPrefixLength());//0.0.255.255 IPAddress broadcastAddress = address.bitwiseOr(hostMask); //1.2.255.255

        Parameters:
        mask -
        retainPrefix -
        Returns:
        Throws:
        AddressConversionException - if the address argument could not be converted to the same address version as this
        IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment

      • bitwiseOrNetwork

        public abstract IPAddress bitwiseOrNetwork(IPAddress mask,
                                           int networkPrefixLength)
                                    throws AddressConversionException,
                                           IncompatibleAddressException
        Does the bitwise disjunction with this address. Useful when subnetting.

        If the mask is a different version than this, then the default conversion is applied first using toIPv4() or toIPv6()

        Any existing prefix length is dropped for the new prefix length and the mask is applied up to the end the new prefix length. It is similar to how the maskNetwork(IPAddress, int) method does the bitwise conjunction.

        Parameters:
        mask -
        networkPrefixLength - the new prefix length for the address
        Returns:
        Throws:
        IncompatibleAddressException - if this is a range of addresses and applying the mask results in an address that cannot be represented as a contiguous range within each segment
        AddressConversionException - if the address argument could not be converted to the same address version as this

      • adjustPrefixLength

        public abstract IPAddress adjustPrefixLength(int adjustment)
        Increases or decreases prefix length by the given increment.

        When prefix length is increased, the bits moved within the prefix become zero. When the prefix is extended beyond the segment series boundary, it is removed. When a prefix length is decreased, the bits moved outside the prefix become zero, and if the entire host address contains the zero address, then the resulting address is determined AddressNetwork.getPrefixConfiguration().

        For example, 1.2.0.0/16 adjusted by -8 becomes 1.0.0.0/8.
        1.2.0.0/16 adjusted by 8 becomes 1.2.0.0/24

        Specified by:
        adjustPrefixLength in interface AddressSegmentSeries
        Specified by:
        adjustPrefixLength in interface IPAddressSegmentSeries
        Specified by:
        adjustPrefixLength in class Address
        Parameters:
        adjustment -
        Returns:

      • getMatchesSQLClause

        public void getMatchesSQLClause(java.lang.StringBuilder builder,
                                java.lang.String sqlExpression)
        Returns a clause for matching this address.

        If this address is a subnet, this method will attempt to match every address in the subnet. Therefore it is much more efficient to use getNetworkSection().getStartsWithSQLClause() for a CIDR subnet.

        Parameters:
        builder -
        sqlExpression -

      • getMatchesSQLClause

        public void getMatchesSQLClause(java.lang.StringBuilder builder,
                                java.lang.String sqlExpression,
                                IPAddressSQLTranslator translator)
        Returns a clause for matching this address.

        Similar to getMatchesSQLClause(StringBuilder builder, String sqlExpression) but allows you to tailor the SQL produced.

        Parameters:
        builder -
        sqlExpression -
        translator -
Skip navigation links