inet.ipaddr

Class IPAddressNetwork.HostIDStringAddressGenerator<T extends HostIdentifierString>

java.lang.Object

inet.ipaddr.IPAddressNetwork.HostIDStringAddressGenerator<T>

Type Parameters:

T - the type to be cached, typically either IPAddressString or HostName

All Implemented Interfaces:

Serializable

Enclosing class:

IPAddressNetwork<T extends IPAddress,R extends IPAddressSection,E extends IPAddressSection,S extends IPAddressSegment,J extends InetAddress>

public abstract static class IPAddressNetwork.HostIDStringAddressGenerator<T extends HostIdentifierString>
extends Object
implements Serializable

Choose a map of your choice to implement a cache of addresses and/or host names.

You can also use this class without a cache to serve as a factory of addresses or host names, which can be particularly useful if you are using your own network, or if you are using your own validation options.

For long-running programs or servers that handle many addresses, the benefits of using a cache are that

• the lookup can provide the same objects for different strings that identify the same host name or address
• parsing and resolving repeated instances of the same address or host string is minimized. Both IPAddressString and HostName cache their parsed and resolved addresses.
• other functionality is optimized through caching, since Host Name, IPAddressString, and IPAddress also caches objects such as generated strings. With cached objects, switching between host names, address strings and numeric addresses is constant time.

You choose the map of your choice to be the backing map for the cache. For example, for thread-safe access to the cache, ConcurrentHashMap is a good choice. For maps of bounded size, LinkedHashMap provides the removeEldestEntry method to override to implement LRU or other eviction mechanisms.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HostIDStringAddressGenerator()
HostIDStringAddressGenerator(IPAddressStringParameters options)
HostIDStringAddressGenerator(Map<String,T> backingMap)
HostIDStringAddressGenerator(Map<String,T> backingMap, IPAddressStringParameters options)

Method Summary

Modifier and Type	Method and Description
T	get(Address.AddressValueProvider addressProvider)
T	get(Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, Integer prefixLength, CharSequence zone)
T	get(byte[] bytes)
T	get(IPAddress.IPAddressValueProvider addressProvider)
T	get(IPAddress.IPVersion version, Address.SegmentValueProvider lowerValueProvider, Address.SegmentValueProvider upperValueProvider, Integer prefixLength)
Map<String,T>	getBackingMap()
static Address.SegmentValueProvider	getValueProvider(byte[] bytes)
static Address.SegmentValueProvider	getValueProvider(byte[] bytes, int segmentByteCount)

Methods inherited from class java.lang.Object

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

Constructor Detail

HostIDStringAddressGenerator

public HostIDStringAddressGenerator()

HostIDStringAddressGenerator

public HostIDStringAddressGenerator(IPAddressStringParameters options)

HostIDStringAddressGenerator

public HostIDStringAddressGenerator(Map<String,T> backingMap)

HostIDStringAddressGenerator

public HostIDStringAddressGenerator(Map<String,T> backingMap,
                                    IPAddressStringParameters options)

Method Detail

getBackingMap

public Map<String,T> getBackingMap()

getValueProvider

public static Address.SegmentValueProvider getValueProvider(byte[] bytes)

getValueProvider

public static Address.SegmentValueProvider getValueProvider(byte[] bytes,
                                                            int segmentByteCount)

get

public T get(byte[] bytes)

get

public T get(Address.AddressValueProvider addressProvider)

get

public T get(IPAddress.IPAddressValueProvider addressProvider)

get

public T get(IPAddress.IPVersion version,
             Address.SegmentValueProvider lowerValueProvider,
             Address.SegmentValueProvider upperValueProvider,
             Integer prefixLength)

get

public T get(Address.SegmentValueProvider lowerValueProvider,
             Address.SegmentValueProvider upperValueProvider,
             Integer prefixLength,
             CharSequence zone)