ICardinalDirection2DMap (formcycle: bom 8.4.0 API)

Type Parameters:

Value - the type of values stored in the map

All Superinterfaces:

Map<ECardinalDirection2D,Value>, Serializable

All Known Subinterfaces:

ICardinalDirection2DMapDouble, ICardinalDirection2DMapInt, ICardinalDirection2DMapLong
```
public interface ICardinalDirection2DMap<Value>
extends Map<ECardinalDirection2D,Value>, Serializable
```
A read-only map that associates values with the four cardinal directions in 2D space (north, east, south, west). This map is ordered: north, east, south, west.

Since:

8.4.0

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Value`	`east()`	Gets the value associated with the east cardinal direction.
`Value`	`north()`	Gets the value associated with the north cardinal direction.
`Value`	`south()`	Gets the value associated with the south cardinal direction.
`Value`	`west()`	Gets the value associated with the west cardinal direction.

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

- Method Detail
  - east
```
Value east()
```
    Gets the value associated with the east cardinal direction.
    
    Returns:
    
    The value associated with the east cardinal direction.
  - north
```
Value north()
```
    Gets the value associated with the north cardinal direction.
    
    Returns:
    
    The value associated with the north cardinal direction.
  - south
```
Value south()
```
    Gets the value associated with the south cardinal direction.
    
    Returns:
    
    The value associated with the south cardinal direction.
  - west
```
Value west()
```
    Gets the value associated with the west cardinal direction.
    
    Returns:
    
    The value associated with the west cardinal direction.