Units (FNSS Java API)

java.lang.Object
- io.github.fnss.Units

```
public class Units
extends Object
```
Utility class providing methods and constants for units validation and conversion

Author:

Lorenzo Saino

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUFFER_SIZE_BYTES`
`static String`	`BUFFER_SIZE_PACKETS`
`static String`	`CAPACITY_BIT_PER_SEC`
`static String`	`CAPACITY_GIGABIT_PER_SEC`
`static String`	`CAPACITY_KILOBIT_PER_SEC`
`static String`	`CAPACITY_MEGABIT_PER_SEC`
`static String`	`DELAY_MICROSECONDS`
`static String`	`DELAY_MILLISECONDS`
`static String`	`DELAY_NANOSECONDS`
`static String`	`DELAY_SECONDS`
`static String`	`DISTANCE_KILOMETERS`
`static String`	`DISTANCE_METERS`
`static String`	`TIME_MICROSECONDS`
`static String`	`TIME_MILLISECONDS`
`static String`	`TIME_MINUTES`
`static String`	`TIME_SECONDS`

Method Summary

Methods
Modifier and Type	Method and Description
`static float`	`convertCapacityValue(float value, String capacityUnit, String targetCapacityUnit)` Convert a capacity value from a time unit to another
`static float`	`convertDelayValue(float value, String delayUnit, String targetDelayUnit)` Convert a delay value from a time unit to another
`static float`	`convertDistanceValue(float value, String distanceUnit, String targetDistanceUnit)` Convert a distance value from a time unit to another
`static float`	`convertTimeValue(float value, String timeUnit, String targetTimeUnit)` Convert a time value from a time unit to another
`static boolean`	`isValidBufferUnit(String bufferUnit)` Verify if the provided buffer size unit is valid or not.
`static boolean`	`isValidCapacityUnit(String capacityUnit)` Verify if the provided capacity unit is valid or not.
`static boolean`	`isValidDelayUnit(String delayUnit)` Verify if the provided delay unit is valid or not.
`static boolean`	`isValidDistanceUnit(String distanceUnit)` Verify if the provided capacity unit is valid or not.
`static boolean`	`isValidTimeUnit(String timeUnit)` Verify if the provided time unit is valid or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CAPACITY_GIGABIT_PER_SEC
```
public static final String CAPACITY_GIGABIT_PER_SEC
```
    See Also:
    Constant Field Values
  - CAPACITY_MEGABIT_PER_SEC
```
public static final String CAPACITY_MEGABIT_PER_SEC
```
    See Also:
    Constant Field Values
  - CAPACITY_KILOBIT_PER_SEC
```
public static final String CAPACITY_KILOBIT_PER_SEC
```
    See Also:
    Constant Field Values
  - CAPACITY_BIT_PER_SEC
```
public static final String CAPACITY_BIT_PER_SEC
```
    See Also:
    Constant Field Values
  - DELAY_NANOSECONDS
```
public static final String DELAY_NANOSECONDS
```
    See Also:
    Constant Field Values
  - DELAY_MICROSECONDS
```
public static final String DELAY_MICROSECONDS
```
    See Also:
    Constant Field Values
  - DELAY_MILLISECONDS
```
public static final String DELAY_MILLISECONDS
```
    See Also:
    Constant Field Values
  - DELAY_SECONDS
```
public static final String DELAY_SECONDS
```
    See Also:
    Constant Field Values
  - TIME_MICROSECONDS
```
public static final String TIME_MICROSECONDS
```
    See Also:
    Constant Field Values
  - TIME_MILLISECONDS
```
public static final String TIME_MILLISECONDS
```
    See Also:
    Constant Field Values
  - TIME_SECONDS
```
public static final String TIME_SECONDS
```
    See Also:
    Constant Field Values
  - TIME_MINUTES
```
public static final String TIME_MINUTES
```
    See Also:
    Constant Field Values
  - DISTANCE_METERS
```
public static final String DISTANCE_METERS
```
    See Also:
    Constant Field Values
  - DISTANCE_KILOMETERS
```
public static final String DISTANCE_KILOMETERS
```
    See Also:
    Constant Field Values
  - BUFFER_SIZE_BYTES
```
public static final String BUFFER_SIZE_BYTES
```
    See Also:
    Constant Field Values
  - BUFFER_SIZE_PACKETS
```
public static final String BUFFER_SIZE_PACKETS
```
    See Also:
    Constant Field Values
- Method Detail
  - isValidTimeUnit
```
public static boolean isValidTimeUnit(String timeUnit)
```
    Verify if the provided time unit is valid or not. Valid time units are "us" (microseconds), "ms" (milliseconds), "sec" (seconds) and "min" (minutes).
    
    Parameters:
    timeUnit - the time unit to be tested.
    
    Returns:
    true if the unit is valid, false otherwise
  - isValidDelayUnit
```
public static boolean isValidDelayUnit(String delayUnit)
```
    Verify if the provided delay unit is valid or not. Valid time units are "ns" (nanoseconds), "us" (microseconds), "ms" (milliseconds), "sec" (seconds) and "min" (minutes).
    
    Parameters:
    delayUnit - the delay unit to be tested.
    
    Returns:
    true if the unit is valid, false otherwise
  - isValidCapacityUnit
```
public static boolean isValidCapacityUnit(String capacityUnit)
```
    Verify if the provided capacity unit is valid or not. Valid time units are "bps" (bit per seconds), "Kbps" (Kbit per second), "Mbps" (Megabit per second), "Gbps" (Gigabit per seconds)
    
    Parameters:
    capacityUnit - the capacity unit to be tested.
    
    Returns:
    true if the unit is valid, false otherwise
  - isValidDistanceUnit
```
public static boolean isValidDistanceUnit(String distanceUnit)
```
    Verify if the provided capacity unit is valid or not. Valid distance units are "m" (meters) and "Km" (kilometers)
    
    Parameters:
    distanceUnit - the distance unit to be tested.
    
    Returns:
    true if the unit is valid, false otherwise
  - isValidBufferUnit
```
public static boolean isValidBufferUnit(String bufferUnit)
```
    Verify if the provided buffer size unit is valid or not. Valid time units are "bytes" or "packets"
    
    Parameters:
    bufferUnit - the buffer unit to be tested.
    
    Returns:
    true if the unit is valid, false otherwise
  - convertTimeValue
```
public static float convertTimeValue(float value,
                     String timeUnit,
                     String targetTimeUnit)
```
    Convert a time value from a time unit to another
    
    Parameters:
    value - The time value to convert
    timeUnit - the original time unit
    targetTimeUnit - the target time unit
    
    Returns:
    the time value expressed in the target unit
  - convertDelayValue
```
public static float convertDelayValue(float value,
                      String delayUnit,
                      String targetDelayUnit)
```
    Convert a delay value from a time unit to another
    
    Parameters:
    value - The delay value to convert
    delayUnit - the original delay unit
    targetDelayUnit - the target delay unit
    
    Returns:
    the delay value expressed in the target unit
  - convertCapacityValue
```
public static float convertCapacityValue(float value,
                         String capacityUnit,
                         String targetCapacityUnit)
```
    Convert a capacity value from a time unit to another
    
    Parameters:
    value - The capacity value to convert
    capacityUnit - the original capacity unit
    targetCapacityUnit - the target capacity unit
    
    Returns:
    the capacity value expressed in the target unit
  - convertDistanceValue
```
public static float convertDistanceValue(float value,
                         String distanceUnit,
                         String targetDistanceUnit)
```
    Convert a distance value from a time unit to another
    
    Parameters:
    value - The capacity value to convert
    distanceUnit - the original distance unit
    targetDistanceUnit - the target distance unit
    
    Returns:
    the distance value expressed in the target unit

Class Units

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CAPACITY_GIGABIT_PER_SEC

CAPACITY_MEGABIT_PER_SEC

CAPACITY_KILOBIT_PER_SEC

CAPACITY_BIT_PER_SEC

DELAY_NANOSECONDS

DELAY_MICROSECONDS

DELAY_MILLISECONDS

DELAY_SECONDS

TIME_MICROSECONDS

TIME_MILLISECONDS

TIME_SECONDS

TIME_MINUTES

DISTANCE_METERS

DISTANCE_KILOMETERS

BUFFER_SIZE_BYTES

BUFFER_SIZE_PACKETS

Method Detail

isValidTimeUnit

isValidDelayUnit

isValidCapacityUnit

isValidDistanceUnit

isValidBufferUnit

convertTimeValue

convertDelayValue

convertCapacityValue

convertDistanceValue