co.mindus.ip2location.ui

Enum IPMode

java.lang.Object

java.lang.Enum<IPMode>

co.mindus.ip2location.ui.IPMode

All Implemented Interfaces:

Serializable, Comparable<IPMode>

public enum IPMode
extends Enum<IPMode>

Enumeration of IP address mode options.

This enum represents the choice between IPv4-only support and combined IPv4+IPv6 support in the IP2Location service.

Database Size Considerations

Mode	Description	Relative DB Size
IPV4_ONLY	IPv4 addresses only	1x
IPV4_AND_IPV6	IPv4 and IPv6 addresses	~2-3x

Choose IPv4-only when IPv6 support is not needed to reduce disk space and memory usage.

Author:

Christopher Mindus

See Also:

IP2LocationConfig

Enum Constant Summary

Enum Constants

Enum Constant and Description
IPV4_AND_IPV6 Both IPv4 and IPv6 addresses.
IPV4_ONLY IPv4 addresses only.

Method Summary

Modifier and Type	Method and Description
static IPMode	fromIncludeIPv6(boolean includeIPv6) Converts a boolean flag to IPMode.
String	getDescription() Gets the full description.
String	getLabel() Gets the short display label.
boolean	includesIPv6() Converts to a boolean flag.
String	toString()
static IPMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static IPMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IPV4_ONLY

public static final IPMode IPV4_ONLY

IPv4 addresses only.

Only IPv4 database files are downloaded and used. IPv6 lookups will return NOT_SUPPORTED status.

IPV4_AND_IPV6

public static final IPMode IPV4_AND_IPV6

Both IPv4 and IPv6 addresses.

Both IPv4 and IPv6 database files are downloaded and used. This roughly doubles the disk and memory requirements.

Method Detail

values

public static IPMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IPMode c : IPMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IPMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getLabel

public String getLabel()

Gets the short display label.

Returns:

The label (e.g., "IPv4")

getDescription

public String getDescription()

Gets the full description.

Returns:

The description

fromIncludeIPv6

public static IPMode fromIncludeIPv6(boolean includeIPv6)

Converts a boolean flag to IPMode.

Parameters:

includeIPv6 - true for IPv4+IPv6, false for IPv4 only

Returns:

The corresponding IPMode

includesIPv6

public boolean includesIPv6()

Converts to a boolean flag.

Returns:

true if this mode includes IPv6

toString

public String toString()

Overrides:

toString in class Enum<IPMode>