Nullsafe (Null Analysis 3.0.2-20170108184519 API)

java.lang.Object
- de.xn__ho_hia.quality.null_analysis.Nullsafe

```
public final class Nullsafe
extends Object
```
Utility classes which helps working with legacy (nullable) APIs.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static @NonNull BigInteger`	`addNullsafe(@Nullable BigInteger first, @Nullable BigInteger second)`
`static @NonNull BigInteger`	`asBigInteger(long value)`
`static @NonNull Long`	`asLong(long value)`
`static @NonNull BigInteger`	`divideNullsafe(@Nullable BigInteger first, @Nullable BigInteger second)`
`static <TYPE> @NonNull List<TYPE>`	`ensureList(@Nullable List<TYPE> list)` Ensures that callers of this method can always work with a `NonNull` `list`.
`static <KEY,VALUE> @NonNull Map<KEY,VALUE>`	`ensureMap(@Nullable Map<KEY,VALUE> map)` Ensures that callers of this method can always work with a `NonNull` `map`.
`static <TYPE> @NonNull Set<TYPE>`	`ensureSet(@Nullable Set<TYPE> set)` Ensures that callers of this method can always work with a `NonNull` `set`.
`static boolean`	`isNullOrEmpty(@Nullable Collection<?> collection)` Safely checks whether a given `collection` is `null` or empty.
`static boolean`	`isNullOrEmpty(@Nullable Map<?,?> map)` Safely checks whether a given `map` is `null` or empty.
`static boolean`	`isNullOrEmpty(@Nullable String string)` Safely checks whether a given `string` is `null` or empty.
`static @NonNull BigInteger`	`multiplyNullsafe(@Nullable BigInteger first, @Nullable BigInteger second)`
`static <TYPE> TYPE`	`nonNull(TYPE reference)` Converts a `Nullable` reference into a `NonNull` reference.
`static <TYPE> TYPE`	`nonNull(TYPE reference, String message)` Converts a `Nullable` reference into a `NonNull` reference.
`static <TYPE> @NonNull Stream<TYPE>`	`safelyStream(@Nullable Collection<TYPE> collection)` Safely creates a `stream` of a nullable `collection`.
`static @NonNull BigInteger`	`subtractNullsafe(@Nullable BigInteger first, @Nullable BigInteger second)`

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

- Method Detail
  - nonNull
```
public static <TYPE> TYPE nonNull(TYPE reference)
```
    Converts a Nullable reference into a NonNull reference. Performs a strict null check that fails in case a null reference is given.
    
    Type Parameters:
    
    TYPE - The type of the reference
    
    Parameters:
    
    reference - A possible null reference.
    
    Returns:
    
    Either the reference itself, or an IllegalArgumentException, in case the reference was null.
  - nonNull
```
public static <TYPE> TYPE nonNull(TYPE reference,
                                  String message)
```
    Converts a Nullable reference into a NonNull reference. Performs a strict null check that fails in case a null reference is given.
    
    Type Parameters:
    
    TYPE - The type of the reference
    
    Parameters:
    
    reference - A possible null reference.
    
    message - The exception message to throw.
    
    Returns:
    
    Either the reference itself, or an IllegalArgumentException, in case the reference was null.
  - safelyStream
```
public static <TYPE> @NonNull Stream<TYPE> safelyStream(@Nullable Collection<TYPE> collection)
```
    Safely creates a stream of a nullable collection. Falls back to an empty stream in case the collection is null.
    
    Type Parameters:
    
    TYPE - The collection type
    
    Parameters:
    
    collection - A collection or null
    
    Returns:
    
    A stream of the given collection or empty stream
  - ensureList
```
public static <TYPE> @NonNull List<TYPE> ensureList(@Nullable List<TYPE> list)
```
    Ensures that callers of this method can always work with a NonNull list. Falls back to an empty list in case the given list is null.
    
    Type Parameters:
    
    TYPE - The list type
    
    Parameters:
    
    list - A list or null
    
    Returns:
    
    The given list or an empty list
  - ensureSet
```
public static <TYPE> @NonNull Set<TYPE> ensureSet(@Nullable Set<TYPE> set)
```
    Ensures that callers of this method can always work with a NonNull set. Falls back to an empty set in case the given set is null.
    
    Type Parameters:
    
    TYPE - The set type
    
    Parameters:
    
    set - A Set or null
    
    Returns:
    
    The given set or an empty set
  - ensureMap
```
public static <KEY,VALUE> @NonNull Map<KEY,VALUE> ensureMap(@Nullable Map<KEY,VALUE> map)
```
    Ensures that callers of this method can always work with a NonNull map. Falls back to an empty map in case the given map is null.
    
    Type Parameters:
    
    KEY - The map key type
    
    VALUE - The map value type
    
    Parameters:
    
    map - A Map or null
    
    Returns:
    
    The given map or an empty map
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(@Nullable Collection<?> collection)
```
    Safely checks whether a given collection is null or empty.
    
    Parameters:
    
    collection - A collection or null
    
    Returns:
    
    true if the collection is null or empty, otherwise false.
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(@Nullable Map<?,?> map)
```
    Safely checks whether a given map is null or empty.
    
    Parameters:
    
    map - A map or null
    
    Returns:
    
    true if the map is null or empty, otherwise false.
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(@Nullable String string)
```
    Safely checks whether a given string is null or empty.
    
    Parameters:
    
    string - A String or null
    
    Returns:
    
    true if the string is null or empty, otherwise false.
  - asBigInteger
```
public static @NonNull BigInteger asBigInteger(long value)
```
    Parameters:
    
    value - The value to wrap
    
    Returns:
    
    A @NonNull BigInteger
  - asLong
```
public static @NonNull Long asLong(long value)
```
    Parameters:
    
    value - The value to wrap
    
    Returns:
    
    A @NonNull Long
  - addNullsafe
```
public static @NonNull BigInteger addNullsafe(@Nullable BigInteger first,
                                              @Nullable BigInteger second)
```
    Parameters:
    
    first - The first value to add
    
    second - The second value to add
    
    Returns:
    
    The sum of both values as a @NonNull BigInteger
  - subtractNullsafe
```
public static @NonNull BigInteger subtractNullsafe(@Nullable BigInteger first,
                                                   @Nullable BigInteger second)
```
    Parameters:
    
    first - The first value to subtract
    
    second - The second value to subtract
    
    Returns:
    
    The difference of both values as a @NonNull BigInteger
  - divideNullsafe
```
public static @NonNull BigInteger divideNullsafe(@Nullable BigInteger first,
                                                 @Nullable BigInteger second)
```
    Parameters:
    
    first - The first value to divide
    
    second - The second value to divide
    
    Returns:
    
    The division of both values as a @NonNull BigInteger
  - multiplyNullsafe
```
public static @NonNull BigInteger multiplyNullsafe(@Nullable BigInteger first,
                                                   @Nullable BigInteger second)
```
    Parameters:
    
    first - The first value to multiply
    
    second - The second value to multiply
    
    Returns:
    
    The multiplication of both values as a @NonNull BigInteger

Class Nullsafe

Method Summary

Methods inherited from class java.lang.Object

Method Detail

nonNull

nonNull

safelyStream

ensureList

ensureSet

ensureMap

isNullOrEmpty

isNullOrEmpty

isNullOrEmpty

asBigInteger

asLong

addNullsafe

subtractNullsafe

divideNullsafe

multiplyNullsafe