BeaufortLevel (meteo-entity 2.0.3 API)

java.lang.Object
- java.lang.Enum<BeaufortLevel>
- - no.api.meteo.entity.extras.BeaufortLevel

All Implemented Interfaces:

Serializable, Comparable<BeaufortLevel>
```
public enum BeaufortLevel
extends Enum<BeaufortLevel>
```
Enum representation of the Beaufort scale. Each enum type represents one level/step/class/unit in this scale.
Resource: http://en.wikipedia.org/wiki/Beaufort_scale

As for now this implementation has english and norwegian (bokmaal) translations of the name on each level

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CALM` Id: 0
`FRESH_BREEZE` Id: 5
`FRESH_GALE` Id: 8
`GENTLE_BREEZE` Id: 3
`HURRICANE_FORCE` Id: 12
`LIGHT_AIR` Id: 1
`LIGHT_BREEZE` Id: 2
`MODERATE_BREEZE` Id: 4
`NEAR_GALE` Id: 7
`STORM` Id: 10
`STRONG_BREEZE` Id: 6
`STRONG_GALE` Id: 9
`VIOLENT_STORM` Id: 11

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BeaufortLevel`	`findUnitById(int value)` Find matching unit for a given number.
`static BeaufortLevel`	`findUnitByKilometersPerHour(double value)` Find matching unit for a given number.
`static BeaufortLevel`	`findUnitByKnots(double value)` Find matching unit for a given number.
`static BeaufortLevel`	`findUnitByMetersPerSecond(double value)` Find matching unit for a given number.
`int`	`getId()` Get the beaufort id.
`BeaufortRange`	`getKmhRange()` Get the unit range in kilometers per hour.
`BeaufortRange`	`getKnRange()` Get the unit range in knots.
`BeaufortRange`	`getMsRange()` Get the unit range in meters per second.
`String`	`getNameEN()` Get he name of the unit.
`String`	`getNameNO()` Get the norwegian (bokmaal) translation of the unit name.
`static BeaufortLevel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BeaufortLevel[]`	`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
  - CALM
```
public static final BeaufortLevel CALM
```
    Id: 0
    
    Sea: Flat
    
    Land: Calm. Smoke rises vertically.
  - LIGHT_AIR
```
public static final BeaufortLevel LIGHT_AIR
```
    Id: 1
    
    Sea: Ripples without crests.
    
    Land: Smoke drift indicates wind direction and wind vanes cease moving.
  - LIGHT_BREEZE
```
public static final BeaufortLevel LIGHT_BREEZE
```
    Id: 2
    
    Sea: Small wavelets. Crests of glassy appearance, not breaking.
    
    Land: Wind felt on exposed skin. Leaves rustle and wind vanes begin to move.
  - GENTLE_BREEZE
```
public static final BeaufortLevel GENTLE_BREEZE
```
    Id: 3
    
    Sea: Large wavelets. Crests begin to break; scattered whitecaps
    
    Land: Leaves and small twigs constantly moving, light flags extended
  - MODERATE_BREEZE
```
public static final BeaufortLevel MODERATE_BREEZE
```
    Id: 4
    
    Sea: Small waves with breaking crests. Fairly frequent whitecaps.
    
    Land: Dust and loose paper raised. Small branches begin to move.
  - FRESH_BREEZE
```
public static final BeaufortLevel FRESH_BREEZE
```
    Id: 5
    
    Sea: Moderate waves of some length. Many whitecaps. Small amounts of spray.
    
    Land: Branches of a moderate size move. Small trees in leaf begin to sway.
  - STRONG_BREEZE
```
public static final BeaufortLevel STRONG_BREEZE
```
    Id: 6
    
    Sea: Long waves begin to form. White foam crests are very frequent. Some airborne spray is present.
    
    Land: Large branches in motion. Whistling heard in overhead wires. Umbrella use becomes difficult. Empty plastic garbage cans tip over.
  - NEAR_GALE
```
public static final BeaufortLevel NEAR_GALE
```
    Id: 7
    
    Sea: Sea heaps up. Some foam from breaking waves is blown into streaks along wind direction. Moderate amounts of airborne spray.
    
    Land: Whole trees in motion. Effort needed to walk against the wind.
  - FRESH_GALE
```
public static final BeaufortLevel FRESH_GALE
```
    Id: 8
    
    Sea: Moderately high waves with breaking crests forming spindrift. Well-marked streaks of foam are blown along wind direction. Considerable airborne spray.
    
    Land: Some twigs broken from trees. Cars veer on road. Progress on foot is seriously impeded.
  - STRONG_GALE
```
public static final BeaufortLevel STRONG_GALE
```
    Id: 9
    
    Sea: High waves whose crests sometimes roll over. Dense foam is blown along wind direction. Large amounts of airborne spray may begin to reduce visibility.
    
    Land: Some branches break off trees, and some small trees blow over. Construction/temporary signs and barricades blow over.
  - STORM
```
public static final BeaufortLevel STORM
```
    Id: 10
    
    Sea: Very high waves with overhanging crests. Large patches of foam from wave crests give the sea a white appearance. Considerable tumbling of waves with heavy impact. Large amounts of airborne spray reduce visibility.
    
    Land: Trees are broken off or uprooted, saplings bent and deformed. Poorly attached asphalt shingles and shingles in poor condition peel off roofs.
  - VIOLENT_STORM
```
public static final BeaufortLevel VIOLENT_STORM
```
    Id: 11
    
    Sea: Exceptionally high waves. Very large patches of foam, driven before the wind, cover much of the sea surface. Very large amounts of airborne spray severely reduce visibility.
    
    Land: Widespread damage to vegetation. Many roofing surfaces are damaged; asphalt tiles that have curled p and/or fractured due to age may break away completely.
  - HURRICANE_FORCE
```
public static final BeaufortLevel HURRICANE_FORCE
```
    Id: 12
    
    Sea: Huge waves. Sea is completely white with foam and spray. Air is filled with driving spray, greatly reducing visibility.
    
    Land: Very widespread damage to vegetation. Some windows may break; mobile homes and poorly constructed sheds and barns are damaged. Debris may be hurled about.
- Method Detail
  - values
```
public static BeaufortLevel[] 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 (BeaufortLevel c : BeaufortLevel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BeaufortLevel 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
  - getKmhRange
```
public BeaufortRange getKmhRange()
```
    Get the unit range in kilometers per hour.
    
    Returns:
    
    Range object containing the start and end values for the unit.
  - getKnRange
```
public BeaufortRange getKnRange()
```
    Get the unit range in knots.
    
    Returns:
    
    Range object containing the start and end values for the unit.
  - getMsRange
```
public BeaufortRange getMsRange()
```
    Get the unit range in meters per second.
    
    Returns:
    
    Range object containing the start and end values for the unit.
  - getNameEN
```
public String getNameEN()
```
    Get he name of the unit.
    
    Returns:
    
    The name of the unit.
  - getNameNO
```
public String getNameNO()
```
    Get the norwegian (bokmaal) translation of the unit name.
    
    Returns:
    
    The name of the unit.
  - getId
```
public int getId()
```
    Get the beaufort id.
    
    Returns:
    
    Number representing the id on the Beaufort scale.
  - findUnitByMetersPerSecond
```
public static BeaufortLevel findUnitByMetersPerSecond(double value)
```
    Find matching unit for a given number.
    
    Parameters:
    
    value - Number representing wind speed in meters per second.
    
    Returns:
    
    A matching unit.
  - findUnitByKnots
```
public static BeaufortLevel findUnitByKnots(double value)
```
    Find matching unit for a given number.
    
    Parameters:
    
    value - Number representing wind speed in knots.
    
    Returns:
    
    A matching unit.
  - findUnitByKilometersPerHour
```
public static BeaufortLevel findUnitByKilometersPerHour(double value)
```
    Find matching unit for a given number.
    
    Parameters:
    
    value - Number representing wind speed in kilometers per hour.
    
    Returns:
    
    A matching unit. If a given value is negative, then CALM is returned. If the value exceeds the Beaufort scale, then HURRICANE_FORCE is returned.
  - findUnitById
```
public static BeaufortLevel findUnitById(int value)
```
    Find matching unit for a given number.
    
    Parameters:
    
    value - Number representing the Beaufort id.
    
    Returns:
    
    A matching unit. If a given value is negative, then CALM is returned. If the value exceeds the Beaufort scale, then HURRICANE_FORCE is returned.

Enum BeaufortLevel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CALM

LIGHT_AIR

LIGHT_BREEZE

GENTLE_BREEZE

MODERATE_BREEZE

FRESH_BREEZE

STRONG_BREEZE

NEAR_GALE

FRESH_GALE

STRONG_GALE

STORM

VIOLENT_STORM

HURRICANE_FORCE

Method Detail

values

valueOf

getKmhRange

getKnRange

getMsRange

getNameEN

getNameNO

getId

findUnitByMetersPerSecond

findUnitByKnots

findUnitByKilometersPerHour

findUnitById