Module io.github.mmm.scanner

Package io.github.mmm.scanner.number

Enum CharScannerRadixMode

java.lang.Object

java.lang.Enum<CharScannerRadixMode>

io.github.mmm.scanner.number.CharScannerRadixMode

All Implemented Interfaces:

CharScannerRadixHandler, Serializable, Comparable<CharScannerRadixMode>, java.lang.constant.Constable

public enum CharScannerRadixMode
extends Enum<CharScannerRadixMode>
implements CharScannerRadixHandler

Enum for to decide on radix when parsing numbers.

See Also:

• CharScannerRadixHandler.radix(int, char)
• CharStreamScanner.readLong(CharScannerRadixHandler)
• CharStreamScanner.readInteger(CharScannerRadixHandler)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Accept any radix (2, 8, 10, 16).
NO_OCTAL	Accept all radix except octal (2, 10, 16).
ONLY_10	Accept only decimal raidx (10).

Method Summary

Modifier and Type	Method	Description
int	radix(int radix, char symbol)	This method will be called if the first character is '0' and will also pass a lookahead of the next character as parameter symbol.
static CharScannerRadixMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CharScannerRadixMode[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final CharScannerRadixMode ALL

Accept any radix (2, 8, 10, 16).

ONLY_10

public static final CharScannerRadixMode ONLY_10

Accept only decimal raidx (10).

NO_OCTAL

public static final CharScannerRadixMode NO_OCTAL

Accept all radix except octal (2, 10, 16).

Method Details

values

public static CharScannerRadixMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CharScannerRadixMode 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

radix

public int radix(int radix,
 char symbol)

Description copied from interface: CharScannerRadixHandler

This method will be called if the first character is '0' and will also pass a lookahead of the next character as parameter symbol.

Specified by:

radix in interface CharScannerRadixHandler

Parameters:

radix - the radix. Will be 16 for "0x", 2 for "0b", 8 for "0" followed by an octal digit (0-7), and 0 in case an unexpected character was found after the first zero.

symbol - the character followed by the leading zero. E.g. 'x' or 'X' for radix 16. You could even implement custom radix mode like "0o" for octal instead of "0" by returning 8 if symbol is 'o' or 'O'.

Returns:

the actual radix to use for further processing. If 0 (or less) is returned the radix is not accepted and "0" is treated as a leading zero rather than a prefix of the radix that will remain to be 10. Typically implementations will return the given radix, but to prevent octal parsing due to a leading zero (Java/C legacy) you can return 10 if 8 was given. If 8 is returned, the symbol will be consumed and skipped if it is not a digit while otherwise the digit will be consumed as part of the number even if it is greater than 7 (finally leading to a NumberFormatException).