Module inet.ipaddr
Package inet.ipaddr
Base classes for IP addresses and generic addresses.
The core types in this package include Address, IPAddress, HostName, IPAddressString and MACAddressString.
- Author:
- sfoley
-
Interface Summary Interface Description Address.AddressValueProvider Address.SegmentValueProvider AddressComponent AddressNetwork.AddressSegmentCreator<S extends AddressSegment> AddressSection AddressSegment Represents a single segment of an address.AddressSegmentSeries Represents a series of address segments, each of equal byte size, the byte size being a whole number of bytes.HostIdentifierString A string that is used to identify a network host.IPAddress.IPAddressValueProvider IPAddressConverter IPAddressSection.SegFunction<R,S> IPAddressSection.SeriesCreator IPAddressSection.TriFunction<R,S> IPAddressSegmentSeries Represents a series of IP address segments. -
Class Summary Class Description Address An address, or a collection of multiple addresses.AddressComparator AddressComparator.CountComparator CountComparator first compares two address items by count, first by bit count for dissimilar items,AddressItem.getBitCount()
, then by count of values for similar items, (AddressItem.getCount()
) and if both match, defers to the address item values for comparison.AddressComparator.ValueComparator ValueComparator is similar to the default comparator CountComparator in the way they treat addresses representing a single address.AddressNetwork<S extends AddressSegment> An object representing a collection of addresses.AddressNetwork.HostIdentifierStringGenerator<T extends HostIdentifierString> Generates and caches HostIdentifierString instances.AddressStringParameters This class allows you to control the validation performed by the classIPAddressString
orMACAddressString
.AddressStringParameters.AddressStringFormatParameters AddressStringParameters.BuilderBase AddressStringParameters.RangeParameters Controls special characters in addresses like '*', '-', '_'HostName An internet host name.HostNameParameters This class allows you to control the validation performed by the classHostName
.HostNameParameters.Builder IPAddress A single IP address, or a subnet of multiple addresses.IPAddress.DualIPv4Pv6Arrays IPAddressConverter.DefaultAddressConverter IPAddressNetwork<T extends IPAddress,R extends IPAddressSection,E extends IPAddressSection,S extends IPAddressSegment,J extends java.net.InetAddress> Represents a network of addresses of a single IP version providing a collection of standard addresses components for that version, such as masks and loopbacks.IPAddressNetwork.HostIDStringAddressGenerator<T extends HostIdentifierString> Choose a map of your choice to implement a cache of addresses and/or host names.IPAddressNetwork.HostNameGenerator Choose a map of your choice to implement a cache of host names and resolved addresses.IPAddressNetwork.IPAddressCreator<T extends IPAddress,R extends IPAddressSection,E extends IPAddressSection,S extends IPAddressSegment,J extends java.net.InetAddress> IPAddressNetwork.IPAddressGenerator A factory of address strings or host names, which can be particularly useful if you are using your own network, or if you are using your own validation options.IPAddressNetwork.IPAddressStringGenerator Choose a map of your choice to implement a cache of address strings and their associated addresses.IPAddressSection A section of an IPAddress.IPAddressSection.IPStringBuilderOptions This user-facing class is designed to be a clear way to create a collection of strings.IPAddressSection.IPStringOptions Represents a clear way to create a specific type of string.IPAddressSection.IPStringOptions.Builder IPAddressSection.WildcardOptions IPAddressSegment This represents a single segment of an IP address.IPAddressSeqRange This class can be used to represent an arbitrary range of consecutive IP addresses.IPAddressString Parses the string representation of an IP address.IPAddressStringParameters This class allows you to control the validation performed by the classIPAddressString
.IPAddressStringParameters.Builder IPAddressStringParameters.IPAddressStringFormatParameters MACAddressString Parses the string representation of a MAC address.MACAddressStringParameters This class allows you to control the validation performed by the classIPAddressString
.MACAddressStringParameters.Builder MACAddressStringParameters.MACAddressStringFormatParameters MACAddressStringParameters.MACAddressStringFormatParameters.Builder PrefixBlockAllocator<E extends IPAddress> Allocates blocks of the desired size from a set of seed blocks provided to it previously for allocation.PrefixBlockAllocator.AllocatedBlock<E extends IPAddress> Represents a block of addresses allocated for assignment to hosts. -
Enum Summary Enum Description AddressNetwork.PrefixConfiguration Prefix Handling Configuration The library is designed to treat prefixes three different ways:IPAddress.IPVersion IPAddressSection.WildcardOptions.WildcardOption MACAddressStringParameters.AddressSize -
Exception Summary Exception Description AddressConversionException AddressPositionException IPv6 and MAC address sections are not position-independent, which means they have a designated location within a full address.AddressStringException AddressValueException Thrown when an address or address component would be too large or small, when a prefix length is too large or small, or when prefixes across segments are inconsistent.HostIdentifierException HostNameException IncompatibleAddressException Represents situations when an address, address section, address segment, or address string represents a valid type or format but that type does not match the required type or format for a given operation.InconsistentPrefixException NetworkMismatchException Thrown when two different networks in use by the same address object are in conflict.PrefixLenException SizeMismatchException