Package net.nullved.pmweatherapi.util

Enum Class StormType

java.lang.Object

java.lang.Enum<StormType>

net.nullved.pmweatherapi.util.StormType

All Implemented Interfaces:

Serializable, Comparable<StormType>, Constable

@Deprecated(forRemoval=true,
            since="0.16.0.0")
public enum StormType
extends Enum<StormType>

Deprecated, for removal: This API element is subject to removal in a future version.

Since 0.16.0.0 | Use PMWeather's StormType instead as of 0.16.0

An enum holding different storm types

Since:

0.15.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CYCLONE	Deprecated, for removal: This API element is subject to removal in a future version.
FIRE_WHIRL	Deprecated, for removal: This API element is subject to removal in a future version.
SQUALL	Deprecated, for removal: This API element is subject to removal in a future version.
SUPERCELL	Deprecated, for removal: This API element is subject to removal in a future version.
TORNADO	Deprecated, for removal: This API element is subject to removal in a future version.

Field Summary

Fields

Modifier and Type	Field	Description
final int	idx	Deprecated, for removal: This API element is subject to removal in a future version.
final int	stage	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static StormType	determineStormType(dev.protomanly.pmweather.weather.Storm storm)	Deprecated, for removal: This API element is subject to removal in a future version.
int	idx()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the index of the StormType
boolean	matches(dev.protomanly.pmweather.weather.Storm storm)	Deprecated, for removal: This API element is subject to removal in a future version. Determines if the Storm meets this StormType's specification.
int	stage()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the minimum stage of the StormType
static StormType	valueOf(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the enum constant of this class with the specified name.
static StormType[]	values()	Deprecated, for removal: This API element is subject to removal in a future version. Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUPERCELL

public static final StormType SUPERCELL

Deprecated, for removal: This API element is subject to removal in a future version.

TORNADO

public static final StormType TORNADO

Deprecated, for removal: This API element is subject to removal in a future version.

SQUALL

public static final StormType SQUALL

Deprecated, for removal: This API element is subject to removal in a future version.

CYCLONE

public static final StormType CYCLONE

Deprecated, for removal: This API element is subject to removal in a future version.

FIRE_WHIRL

public static final StormType FIRE_WHIRL

Deprecated, for removal: This API element is subject to removal in a future version.

Field Details

idx

public final int idx

Deprecated, for removal: This API element is subject to removal in a future version.

stage

public final int stage

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

values

public static StormType[] values()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StormType valueOf(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

idx

public int idx()

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the index of the StormType

Returns:

The StormType index

Since:

0.15.0.0

stage

public int stage()

Deprecated, for removal: This API element is subject to removal in a future version.

Gets the minimum stage of the StormType

Returns:

The minimum stage of the StormType

Since:

0.15.0.0

matches

public boolean matches(dev.protomanly.pmweather.weather.Storm storm)

Deprecated, for removal: This API element is subject to removal in a future version.

Determines if the Storm meets this StormType's specification. If this StormType defines a `stage` (such as TORNADO), the Storm must be equal to or above that stage

Parameters:

storm - The Storm to check

Returns:

true if this Storm meets the StormType specification

Since:

0.15.0.0

determineStormType

public static StormType determineStormType(dev.protomanly.pmweather.weather.Storm storm)

Deprecated, for removal: This API element is subject to removal in a future version.