Package ru.progrm_jarvis.javacommons.primitive

Class NumberUtil

java.lang.Object

ru.progrm_jarvis.javacommons.primitive.NumberUtil

public final class NumberUtil
extends Object

Utilities related to numbers.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_RADIX	Default radix of a number.
static final int	INT_NON_SIGN_BITS	Number of bits in an int except for the sign bit.
static final int	LONG_NON_SIGN_BITS	Number of bits in a long except for the sign bit.

Method Summary

Modifier and Type	Method	Description
static @NotNull OptionalInt	parseInt(@NonNull CharSequence possibleInteger)	Parses a decimal int number.
static @NotNull OptionalInt	parseInt(@NonNull CharSequence possibleInteger, int radix)	Parses an int number.
static @NotNull Result<@NotNull Integer,@NotNull IntegerParseError>	parseIntResult(@NonNull CharSequence possibleInteger)	Parses a decimal int number.
static @NotNull Result<@NotNull Integer,@NotNull IntegerParseError>	parseIntResult(@NonNull CharSequence possibleInteger, int radix)	Parses an int number.
static @NotNull OptionalLong	parseLong(@NonNull CharSequence possibleLong)	Parses a decimal long number.
static @NotNull OptionalLong	parseLong(@NonNull CharSequence possibleLong, int radix)	Parses a long number.
static @NotNull Result<@NotNull Long,@NotNull IntegerParseError>	parseLongResult(@NonNull CharSequence possibleLong)	Parses a decimal long number.
static @NotNull Result<@NotNull Long,@NotNull IntegerParseError>	parseLongResult(@NonNull CharSequence possibleLong, int radix)	Parses a long number.
static int	saturatingSum(int left, int right)	Sums the int values using their bounds instead of wrapping on overflow.
static long	saturatingSum(long left, long right)	Sums the long values using their bounds instead of wrapping on overflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INT_NON_SIGN_BITS

public static final int INT_NON_SIGN_BITS

Number of bits in an int except for the sign bit.

See Also:

• Constant Field Values

LONG_NON_SIGN_BITS

public static final int LONG_NON_SIGN_BITS

Number of bits in a long except for the sign bit.

See Also:

• Constant Field Values

DEFAULT_RADIX

public static final int DEFAULT_RADIX

Default radix of a number.

See Also:

• Constant Field Values

Method Details

parseInt

@NotNull
public static @NotNull OptionalInt parseInt(@NonNull
 @NonNull CharSequence possibleInteger,
 int radix)

Parses an int number.

This method is based on OpenJDK Integer.parseInt(String, int) but it returns OptionalInt to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleInteger - string which is expected to contain an int number but may not

radix - radix of the possible number

Returns:

optional containing the parsed number or an empty one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseInt

@NotNull
public static @NotNull OptionalInt parseInt(@NonNull
 @NonNull CharSequence possibleInteger)

Parses a decimal int number.

This method is based on OpenJDK Integer.parseInt(String, int) but it returns OptionalInt to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleInteger - string which is expected to contain an int number but may not

Returns:

optional containing the parsed number or an empty one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseIntResult

@NotNull
public static @NotNull Result<@NotNull Integer,@NotNull IntegerParseError> parseIntResult(@NonNull
 @NonNull CharSequence possibleInteger,
 int radix)

Parses an int number.

This method is based on OpenJDK Integer.parseInt(String, int) but it returns Result to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleInteger - string which is expected to contain an int number but may not

radix - radix of the possible number

Returns:

result containing the parsed number or an error one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseIntResult

@NotNull
public static @NotNull Result<@NotNull Integer,@NotNull IntegerParseError> parseIntResult(@NonNull
 @NonNull CharSequence possibleInteger)

Parses a decimal int number.

This method is based on OpenJDK Integer.parseInt(String, int) but it returns Result to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleInteger - string which is expected to contain an int number but may not

Returns:

result containing the parsed number or an error one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseLong

@NotNull
public static @NotNull OptionalLong parseLong(@NonNull
 @NonNull CharSequence possibleLong,
 int radix)

Parses a long number.

This method is based on OpenJDK Long.parseLong(String, int) but it returns OptionalLong to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleLong - string which is expected to contain a long number but may not

radix - radix of the possible number

Returns:

optional containing the parsed number or an empty one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseLong

@NotNull
public static @NotNull OptionalLong parseLong(@NonNull
 @NonNull CharSequence possibleLong)

Parses a decimal long number.

This method is based on OpenJDK Long.parseLong(String, int) but it returns OptionalLong to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleLong - string which is expected to contain a long number but may not

Returns:

optional containing the parsed number or an empty one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseLongResult

@NotNull
public static @NotNull Result<@NotNull Long,@NotNull IntegerParseError> parseLongResult(@NonNull
 @NonNull CharSequence possibleLong,
 int radix)

Parses a long number.

This method is based on OpenJDK Long.parseLong(String, int) but it returns Result to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleLong - string which is expected to contain a long number but may not

radix - radix of the possible number

Returns:

result containing the parsed number or an error one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

parseLongResult

@NotNull
public static @NotNull Result<@NotNull Long,@NotNull IntegerParseError> parseLongResult(@NonNull
 @NonNull CharSequence possibleLong)

Parses a decimal long number.

This method is based on OpenJDK Long.parseLong(String, int) but it returns Result to handle invalid input instead of throwing NumberFormatException.

Parameters:

possibleLong - string which is expected to contain a long number but may not

Returns:

result containing the parsed number or an error one if it could not be parsed

Throws:

IllegalArgumentException - if the radix is out of bound [Character.MIN_RADIX; Character.MAX_RADIX].

saturatingSum

public static int saturatingSum(int left,
 int right)

Sums the int values using their bounds instead of wrapping on overflow.

Parameters:

left - left addend

right - right addend

Returns:

sum of the addends

Implementation note

implementation is based on Stackoverflow answer

saturatingSum

public static long saturatingSum(long left,
 long right)

Sums the long values using their bounds instead of wrapping on overflow.

Parameters:

left - left addend

right - right addend

Returns:

sum of the addends

Implementation note

implementation is based on Stackoverflow answer