com.atakmap.comms

Enum CommsMapComponent.ImportResult

java.lang.Object

java.lang.Enum<CommsMapComponent.ImportResult>

com.atakmap.comms.CommsMapComponent.ImportResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommsMapComponent.ImportResult>

Enclosing class:

CommsMapComponent

public static enum CommsMapComponent.ImportResult
extends java.lang.Enum<CommsMapComponent.ImportResult>

Status of an import, either one of SUCCESS - no problems FAILURE - problems not importable. DEFERRED - waiting on another item, so try again at the end. IGNORE - no problems, but also not handled

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFERRED
FAILURE
IGNORE
SUCCESS

Method Summary

Modifier and Type	Method and Description
CommsMapComponent.ImportResult	getHigherPriority(CommsMapComponent.ImportResult other) Compare this import result with another and return the result with higher priority.
static CommsMapComponent.ImportResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommsMapComponent.ImportResult[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final CommsMapComponent.ImportResult SUCCESS

FAILURE

public static final CommsMapComponent.ImportResult FAILURE

DEFERRED

public static final CommsMapComponent.ImportResult DEFERRED

IGNORE

public static final CommsMapComponent.ImportResult IGNORE

Method Detail

values

public static CommsMapComponent.ImportResult[] 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 (CommsMapComponent.ImportResult c : CommsMapComponent.ImportResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommsMapComponent.ImportResult valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getHigherPriority

public CommsMapComponent.ImportResult getHigherPriority(CommsMapComponent.ImportResult other)

Compare this import result with another and return the result with higher priority. This is useful when performing multiple import operations in a method where a single result is returned. IGNORE < SUCCESS < DEFERRED < FAILURE

Parameters:

other - Other result

Returns:

The result with higher priority