Bytes (JJWT :: Impl 0.12.6 API)

java.lang.Object
- io.jsonwebtoken.impl.lang.Bytes

```
public final class Bytes
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static byte[] EMPTY

static String INT_REQD_MSG

static String LONG_REQD_MSG

Fields
Modifier and Type	Field and Description
`static byte[]`	`EMPTY`
`static String`	`INT_REQD_MSG`
`static String`	`LONG_REQD_MSG`

Method Summary

Methods
Modifier and Type	Method and Description
`static long`	`bitLength(byte[] bytes)`
`static String`	`bitsMsg(long bitLength)`
`static String`	`bytesMsg(int byteArrayLength)`
`static void`	`clear(byte[] bytes)` Clears the array by filling it with all zeros.
`static byte[]`	`concat(byte[]... arrays)`
`static boolean`	`endsWith(byte[] src, byte[] suffix)`
`static void`	`increment(byte[] a)`
`static int`	`indexOf(byte[] source, byte[] target)`
`static int`	`indexOf(byte[] source, byte[] target, int fromIndex)`
`static boolean`	`isEmpty(byte[] bytes)`
`static int`	`length(byte[] bytes)`
`static int`	`length(int bitLength)` Returns the minimum number of bytes required to represent the specified number of bits.
`static byte[]`	`nullSafe(byte[] bytes)`
`static byte[]`	`prepad(byte[] bytes, int length)` Pads the front of the specified byte array with zeros if necessary, returning a new padded result, or the original array unmodified if padding isn't necessary.
`static byte[]`	`random(int numBytes)`
`static byte[]`	`randomBits(int numBits)`
`static boolean`	`startsWith(byte[] src, byte[] prefix)`
`static boolean`	`startsWith(byte[] src, byte[] prefix, int offset)`
`static byte[]`	`toBytes(int i)`
`static byte[]`	`toBytes(long l)`
`static int`	`toInt(byte[] bytes)`
`static long`	`toLong(byte[] bytes)`

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

- Field Detail
  - EMPTY
```
public static final byte[] EMPTY
```
  - LONG_REQD_MSG
```
public static final String LONG_REQD_MSG
```
    See Also:
    Constant Field Values
  - INT_REQD_MSG
```
public static final String INT_REQD_MSG
```
    See Also:
    Constant Field Values
- Method Detail
  - nullSafe
```
public static byte[] nullSafe(byte[] bytes)
```
  - randomBits
```
public static byte[] randomBits(int numBits)
```
  - random
```
public static byte[] random(int numBytes)
```
  - toBytes
```
public static byte[] toBytes(int i)
```
  - toBytes
```
public static byte[] toBytes(long l)
```
  - toLong
```
public static long toLong(byte[] bytes)
```
  - toInt
```
public static int toInt(byte[] bytes)
```
  - indexOf
```
public static int indexOf(byte[] source,
          byte[] target)
```
  - indexOf
```
public static int indexOf(byte[] source,
          byte[] target,
          int fromIndex)
```
  - startsWith
```
public static boolean startsWith(byte[] src,
                 byte[] prefix)
```
  - startsWith
```
public static boolean startsWith(byte[] src,
                 byte[] prefix,
                 int offset)
```
  - endsWith
```
public static boolean endsWith(byte[] src,
               byte[] suffix)
```
  - concat
```
public static byte[] concat(byte[]... arrays)
```
  - clear
```
public static void clear(byte[] bytes)
```
    Clears the array by filling it with all zeros. Does nothing with a null or empty argument.
    
    Parameters:
    bytes - the (possibly null or empty) byte array to clear
  - isEmpty
```
public static boolean isEmpty(byte[] bytes)
```
  - length
```
public static int length(byte[] bytes)
```
  - bitLength
```
public static long bitLength(byte[] bytes)
```
  - length
```
public static int length(int bitLength)
```
    Returns the minimum number of bytes required to represent the specified number of bits.
    This is defined/used by many specifications, such as:
    - JWA RFC 7518, Section 2's Base64urlUInt definition
    - Elliptic Curve Integer-to-OctetString conversion defined by Section 2.3.7 of the Standards for Efficient Cryptography Group, &qupt;SEC 1: Elliptic Curve Cryptography" Version 2.0, May 2009 (as required by RFC 7518, Section 3.4)
    - and others.
    Parameters:
    bitLength - the number of bits to represent as a byte array, must be >= 0
    
    Returns:
    the minimum number of bytes required to represent the specified number of bits.
    
    Throws:
    
    IllegalArgumentException - if bitLength is less than zero.
  - bitsMsg
```
public static String bitsMsg(long bitLength)
```
  - bytesMsg
```
public static String bytesMsg(int byteArrayLength)
```
  - increment
```
public static void increment(byte[] a)
```
  - prepad
```
public static byte[] prepad(byte[] bytes,
            int length)
```
    Pads the front of the specified byte array with zeros if necessary, returning a new padded result, or the original array unmodified if padding isn't necessary. Padding is only performed if length is greater than bytes.length.
    
    Parameters:
    bytes - the byte array to pre-pad with zeros if necessary
    length - the length of the required output array
    
    Returns:
    the potentially pre-padded byte array, or the existing bytes array if padding wasn't necessary.
    Since:
    
    0.12.4

Class Bytes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

LONG_REQD_MSG

INT_REQD_MSG

Method Detail

nullSafe

randomBits

random

toBytes

toBytes

toLong

toInt

indexOf

indexOf

startsWith

startsWith

endsWith

concat

clear

isEmpty

length

bitLength

length

bitsMsg

bytesMsg

increment

prepad