|
|
|
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD |
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class HexFormat
java.util.HexFormat
public final class HexFormat
HexFormat converts between bytes and chars and hex-encoded strings which may include
additional formatting markup such as prefixes, suffixes, and delimiters.
There are two factories of HexFormat with preset parameters of() and
ofDelimiter(delimiter). For other parameter combinations
the withXXX methods return copies of HexFormat modified
withPrefix(String), withSuffix(String), withDelimiter(String)
or choice of withUpperCase() or withLowerCase() parameters.
For primitive to hexadecimal string conversions the toHexDigits
methods include toHexDigits(byte), toHexDigits(int), and
toHexDigits(long), etc. The default is to use lowercase characters "0-9","a-f".
For conversions producing uppercase hexadecimal the characters are "0-9","A-F".
Only the HexFormat.isUpperCase() parameter is
considered; the delimiter, prefix and suffix are not used.
For hexadecimal string to primitive conversions the fromHexDigits
methods include fromHexDigits(string),
fromHexDigitsToLong(string), and
fromHexDigit(int) converts a single character or codepoint.
For conversions from hexadecimal characters the digits and uppercase and lowercase
characters in "0-9", "a-f", and "A-F" are converted to corresponding values
0-15. The delimiter, prefix, suffix, and uppercase parameters are not used.
For byte array to formatted hexadecimal string conversions
the formatHex methods include formatHex(byte[])
and formatHex(Appendable, byte[]).
The formatted output is a string or is appended to an Appendable such as
StringBuilder or PrintStream.
Each byte value is formatted as the prefix, two hexadecimal characters from the
uppercase or lowercase digits, and the suffix.
A delimiter follows each formatted value, except the last.
For conversions producing uppercase hexadecimal strings use withUpperCase().
For formatted hexadecimal string to byte array conversions the
parseHex methods include parseHex(CharSequence) and
parseHex(char[], offset, length).
Each byte value is parsed from the prefix, two case insensitive hexadecimal characters,
and the suffix. A delimiter follows each formatted value, except the last.
Since:
17
Method Summary |
|
Returns the delimiter between hexadecimal values in formatted hexadecimal strings.
|
boolean |
Returns true if the other object is a HexFormat
with the same parameters.
|
|
Appends formatted hexadecimal strings from a byte array to the Appendable.
|
|
formatHex( A out, byte[] bytes, int fromIndex, int toIndex)
Appends formatted hexadecimal strings from a byte array range to the Appendable.
|
|
Returns a hexadecimal string formatted from a byte array.
|
|
formatHex(byte[] bytes, int fromIndex, int toIndex)
Returns a hexadecimal string formatted from a byte array range.
|
static int |
Returns the value for the hexadecimal character or codepoint.
|
static int |
Returns the int value parsed from a string of up to eight hexadecimal characters.
|
static int |
Returns the int value parsed from a string range of up to eight hexadecimal
characters.
|
static long |
Returns the long value parsed from a string of up to sixteen hexadecimal characters.
|
static long |
Returns the long value parsed from a string range of up to sixteen hexadecimal
characters.
|
int |
Returns a hashcode for this HexFormat.
|
static boolean |
Returns true if the character is a valid hexadecimal character or codepoint.
|
boolean |
Returns true if the hexadecimal digits are uppercase,
otherwise false.
|
|
Returns a hexadecimal formatter with no delimiter and lowercase characters.
|
|
Returns a hexadecimal formatter with the delimiter and lowercase characters.
|
byte[] |
parseHex(char[] chars, int fromIndex, int toIndex)
Returns a byte array containing hexadecimal values parsed from
a range of the character array.
|
byte[] |
Returns a byte array containing hexadecimal values parsed from the string.
|
byte[] |
Returns a byte array containing hexadecimal values parsed from a range of the string.
|
|
Returns the prefix used for each hexadecimal value in formatted hexadecimal strings.
|
|
Returns the suffix used for each hexadecimal value in formatted hexadecimal strings.
|
|
Appends two hexadecimal characters for the byte value to the Appendable.
|
|
Returns the two hexadecimal characters for the byte value.
|
|
Returns the four hexadecimal characters for the char value.
|
|
Returns the eight hexadecimal characters for the int value.
|
|
Returns the sixteen hexadecimal characters for the long value.
|
|
Returns up to sixteen hexadecimal characters for the long value.
|
|
Returns the four hexadecimal characters for the short value.
|
char |
Returns the hexadecimal character for the high 4 bits of the value considering it to be a byte.
|
char |
Returns the hexadecimal character for the low 4 bits of the value considering it to be a byte.
|
|
Returns a description of the formatter parameters for uppercase,
delimiter, prefix, and suffix.
|
|
Returns a copy of this HexFormat with the delimiter.
|
|
Returns a copy of this HexFormat to use lowercase hexadecimal characters.
|
|
Returns a copy of this HexFormat with the prefix.
|
|
Returns a copy of this HexFormat with the suffix.
|
|
Returns a copy of this HexFormat to use uppercase hexadecimal characters.
|
Methods inherited from class java.lang. Object |
|
Returns a hexadecimal formatter with no delimiter and lowercase characters.
The delimiter, prefix, and suffix are empty.
The methods
withDelimiter,
withUpperCase,
withLowerCase,
withPrefix, and
withSuffix
return copies of formatters with new parameters.
Returns:
a hexadecimal formatter with no delimiter and lowercase characters
Returns a hexadecimal formatter with the delimiter and lowercase characters.
The prefix and suffix are empty.
The methods
withDelimiter,
withUpperCase,
withLowerCase,
withPrefix, and
withSuffix
return copies of formatters with new parameters.
Parameters:
delimiter - a delimiter, non-null, may be empty
Returns:
a
HexFormat with the delimiter and lowercase characters
Returns a copy of this
HexFormat with the delimiter.
Parameters:
delimiter - the delimiter, non-null, may be empty
Returns:
a copy of this HexFormat with the delimiter
Returns a copy of this
HexFormat with the prefix.
Parameters:
prefix - a prefix, non-null, may be empty
Returns:
a copy of this HexFormat with the prefix
Returns a copy of this
HexFormat with the suffix.
Parameters:
suffix - a suffix, non-null, may be empty
Returns:
a copy of this HexFormat with the suffix
Returns a copy of this
HexFormat to use uppercase hexadecimal characters.
The uppercase hexadecimal characters are
"0-9", "A-F".
Returns:
a copy of this HexFormat with uppercase hexadecimal characters
Returns a copy of this
HexFormat to use lowercase hexadecimal characters.
The lowercase hexadecimal characters are
"0-9", "a-f".
Returns:
a copy of this HexFormat with lowercase hexadecimal characters
Returns the delimiter between hexadecimal values in formatted hexadecimal strings.
Returns:
the delimiter, non-null, may be empty ""
Returns the prefix used for each hexadecimal value in formatted hexadecimal strings.
Returns:
the prefix, non-null, may be empty ""
Returns the suffix used for each hexadecimal value in formatted hexadecimal strings.
Returns:
the suffix, non-null, may be empty ""
public boolean isUpperCase |
() |
Returns
true if the hexadecimal digits are uppercase,
otherwise
false.
Returns:
true if the hexadecimal digits are uppercase,
otherwise false
Returns a hexadecimal string formatted from a byte array.
Each byte value is formatted as the prefix, two hexadecimal characters
selected from uppercase or lowercase digits, and the suffix.
A delimiter follows each formatted value, except the last.
The behavior is equivalent to
formatHex(bytes, 0, bytes.length)).
Parameters:
bytes - a non-null array of bytes
Returns:
a string hexadecimal formatting of the byte array
|
(byte[] bytes, int fromIndex, int toIndex) |
Returns a hexadecimal string formatted from a byte array range.
Each byte value is formatted as the prefix, two hexadecimal characters
selected from uppercase or lowercase digits, and the suffix.
A delimiter follows each formatted value, except the last.
Parameters:
bytes - a non-null array of bytes
fromIndex - the initial index of the range, inclusive
toIndex - the final index of the range, exclusive
Returns:
a string hexadecimal formatting each byte of the array range
Throws:
Appends formatted hexadecimal strings from a byte array to the
Appendable.
Each byte value is formatted as the prefix, two hexadecimal characters
selected from uppercase or lowercase digits, and the suffix.
A delimiter follows each formatted value, except the last.
The formatted hexadecimal strings are appended in zero or more calls to the
Appendable methods.
Type Parameters:
A - The type of
Appendable Parameters:
out - an
Appendable, non-null
bytes - a byte array
Returns:
the Appendable
Throws:
|
( A out, byte[] bytes, int fromIndex, int toIndex) |
Appends formatted hexadecimal strings from a byte array range to the
Appendable.
Each byte value is formatted as the prefix, two hexadecimal characters
selected from uppercase or lowercase digits, and the suffix.
A delimiter follows each formatted value, except the last.
The formatted hexadecimal strings are appended in zero or more calls to the
Appendable methods.
Type Parameters:
A - The type of
Appendable Parameters:
out - an
Appendable, non-null
bytes - a byte array, non-null
fromIndex - the initial index of the range, inclusive
toIndex - the final index of the range, exclusive.
Returns:
the Appendable
Throws:
Returns a byte array containing hexadecimal values parsed from the string.
Each byte value is parsed from the prefix, two case insensitive hexadecimal characters,
and the suffix. A delimiter follows each formatted value, except the last.
The delimiters, prefixes, and suffixes strings must be present; they may be empty strings.
A valid string consists only of the above format.
Parameters:
string - a string containing the byte values with prefix, hexadecimal digits, suffix,
and delimiters
Returns:
a byte array with the values parsed from the string
Throws:
IllegalArgumentException - if the prefix or suffix is not present for each byte value,
the byte values are not hexadecimal characters, or if the delimiter is not present
after all but the last byte value
Returns a byte array containing hexadecimal values parsed from a range of the string.
Each byte value is parsed from the prefix, two case insensitive hexadecimal characters,
and the suffix. A delimiter follows each formatted value, except the last.
The delimiters, prefixes, and suffixes strings must be present; they may be empty strings.
A valid string consists only of the above format.
Parameters:
string - a string range containing hexadecimal digits,
delimiters, prefix, and suffix.
fromIndex - the initial index of the range, inclusive
toIndex - the final index of the range, exclusive.
Returns:
a byte array with the values parsed from the string range
Throws:
IllegalArgumentException - if the prefix or suffix is not present for each byte value,
the byte values are not hexadecimal characters, or if the delimiter is not present
after all but the last byte value
public byte[] parseHex |
(char[] chars, int fromIndex, int toIndex) |
Returns a byte array containing hexadecimal values parsed from
a range of the character array.
Each byte value is parsed from the prefix, two case insensitive hexadecimal characters,
and the suffix. A delimiter follows each formatted value, except the last.
The delimiters, prefixes, and suffixes strings must be present; they may be empty strings.
A valid character array range consists only of the above format.
Parameters:
chars - a character array range containing an even number of hexadecimal digits,
delimiters, prefix, and suffix.
fromIndex - the initial index of the range, inclusive
toIndex - the final index of the range, exclusive.
Returns:
a byte array with the values parsed from the character array range
Throws:
IllegalArgumentException - if the prefix or suffix is not present for each byte value,
the byte values are not hexadecimal characters, or if the delimiter is not present
after all but the last byte value
public char toLowHexDigit |
(int value) |
Returns the hexadecimal character for the low 4 bits of the value considering it to be a byte.
If the parameter
isUpperCase() is
true the
character returned for values
10-15 is uppercase
"A-F",
otherwise the character returned is lowercase
"a-f".
The values in the range
0-9 are returned as
"0-9".
Parameters:
value - a value, only the low 4 bits 0-3 of the value are used
Returns:
the hexadecimal character for the low 4 bits 0-3 of the value
public char toHighHexDigit |
(int value) |
Returns the hexadecimal character for the high 4 bits of the value considering it to be a byte.
If the parameter
isUpperCase() is
true the
character returned for values
10-15 is uppercase
"A-F",
otherwise the character returned is lowercase
"a-f".
The values in the range
0-9 are returned as
"0-9".
Parameters:
value - a value, only bits 4-7 of the value are used
Returns:
the hexadecimal character for the bits 4-7 of the value
Appends two hexadecimal characters for the byte value to the
Appendable.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The hexadecimal characters are appended in one or more calls to the
Appendable methods. The delimiter, prefix and suffix are not used.
Type Parameters:
A - The type of
Appendable Parameters:
out - an
Appendable, non-null
value - a byte value
Returns:
the Appendable
Throws:
Returns the two hexadecimal characters for the
byte value.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The delimiter, prefix and suffix are not used.
Parameters:
value - a byte value
Returns:
the two hexadecimal characters for the byte value
Returns the four hexadecimal characters for the
char value.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The delimiter, prefix and suffix are not used.
Parameters:
value - a char value
Returns:
the four hexadecimal characters for the char value
Returns the four hexadecimal characters for the
short value.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The delimiter, prefix and suffix are not used.
Parameters:
value - a short value
Returns:
the four hexadecimal characters for the short value
Returns the eight hexadecimal characters for the
int value.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The delimiter, prefix and suffix are not used.
Parameters:
value - an int value
Returns:
the eight hexadecimal characters for the int value
See Also:
Returns the sixteen hexadecimal characters for the
long value.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The delimiter, prefix and suffix are not used.
Parameters:
value - a long value
Returns:
the sixteen hexadecimal characters for the long value
See Also:
Returns up to sixteen hexadecimal characters for the
long value.
Each nibble (4 bits) from most significant to least significant of the value
is formatted as if by
toLowHexDigit(nibble).
The delimiter, prefix and suffix are not used.
Parameters:
value - a
long value
digits - the number of hexadecimal digits to return, 0 to 16
Returns:
the hexadecimal characters for the long value
Throws:
public static boolean isHexDigit |
(int ch) |
Returns
true if the character is a valid hexadecimal character or codepoint.
The valid hexadecimal characters are:
- '0' ('\u0030') through '9' ('\u0039') inclusive,
- 'A' ('\u0041') through 'F' ('\u0046') inclusive, and
- 'a' ('\u0061') through 'f' ('\u0066') inclusive.
Parameters:
ch - a codepoint
Returns:
true if the character is valid a hexadecimal character,
otherwise false
public static int fromHexDigit |
(int ch) |
Returns the value for the hexadecimal character or codepoint.
The value is:
- (ch - '0') for '0' through '9' inclusive,
- (ch - 'A' + 10) for 'A' through 'F' inclusive, and
- (ch - 'a' + 10) for 'a' through 'f' inclusive.
Parameters:
ch - a character or codepoint
Returns:
the value 0-15
Throws:
public static int fromHexDigits |
|
Returns the
int value parsed from a string of up to eight hexadecimal characters.
The hexadecimal characters are parsed from most significant to least significant
using
fromHexDigit(int) to form an unsigned value.
The value is zero extended to 32 bits and is returned as an
int.
Parameters:
string - a CharSequence containing up to eight hexadecimal characters
Returns:
the value parsed from the string
Throws:
IllegalArgumentException - if the string length is greater than eight (8) or
if any of the characters is not a hexadecimal character
public static int fromHexDigits |
|
Returns the
int value parsed from a string range of up to eight hexadecimal
characters.
The characters in the range
fromIndex to
toIndex, exclusive,
are parsed from most significant to least significant
using
fromHexDigit(int) to form an unsigned value.
The value is zero extended to 32 bits and is returned as an
int.
Parameters:
string - a CharSequence containing the characters
fromIndex - the initial index of the range, inclusive
toIndex - the final index of the range, exclusive.
Returns:
the value parsed from the string range
Throws:
public static long fromHexDigitsToLong |
|
Returns the long value parsed from a string of up to sixteen hexadecimal characters.
The hexadecimal characters are parsed from most significant to least significant
using
fromHexDigit(int) to form an unsigned value.
The value is zero extended to 64 bits and is returned as a
long.
Parameters:
string - a CharSequence containing up to sixteen hexadecimal characters
Returns:
the value parsed from the string
Throws:
IllegalArgumentException - if the string length is greater than sixteen (16) or
if any of the characters is not a hexadecimal character
public static long fromHexDigitsToLong |
|
Returns the long value parsed from a string range of up to sixteen hexadecimal
characters.
The characters in the range
fromIndex to
toIndex, exclusive,
are parsed from most significant to least significant
using
fromHexDigit(int) to form an unsigned value.
The value is zero extended to 64 bits and is returned as a
long.
Parameters:
string - a CharSequence containing the characters
fromIndex - the initial index of the range, inclusive
toIndex - the final index of the range, exclusive.
Returns:
the value parsed from the string range
Throws:
Returns
true if the other object is a
HexFormat
with the same parameters.
Overrides:
Parameters:
o - an object, may be null
Returns:
true if the other object is a HexFormat and the parameters
uppercase, delimiter, prefix, and suffix are equal;
otherwise false
See Also:
Returns a hashcode for this
HexFormat.
Overrides:
Returns:
a hashcode for this HexFormat
See Also:
Returns a description of the formatter parameters for uppercase,
delimiter, prefix, and suffix.
Overrides:
Returns:
a description of this HexFormat
|
|
|
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD |
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz