Index
All Classes and Interfaces|All Packages
A
- addListener(JsonListener) - Method in class com.bfo.json.Json
-
Add a
JsonListener
to this class, if it has not already been added. - after - Variable in class com.bfo.json.JsonEvent
-
The Json object after the event.
B
- before - Variable in class com.bfo.json.JsonEvent
-
The Json object before the event.
- booleanValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a boolean.
- booleanValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.booleanValue()
method on it, otherwise return false - bufferValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a ByteBuffer.
- bufferValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.bufferValue()
method on it, otherwise return null
C
- com.bfo.json - package com.bfo.json
-
Package relating to Json, Cbor, Msgpack, and all classes relating to JWK and COSE
- complete(Json) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Called once when the Json reading ends
- COSE - Class in com.bfo.json
-
A basic COSE class.
- COSE() - Constructor for class com.bfo.json.COSE
-
Create a new, uninitialized COSE object
- COSE(Json) - Constructor for class com.bfo.json.COSE
-
Create a new COSE from one that has already been read, eg
COSE cose = new COSE(Json.readCbor(..., null))
- createArrayBuilder() - Method in class com.bfo.json.JSRProvider
- createArrayBuilder(Collection<?>) - Method in class com.bfo.json.JSRProvider
- createArrayBuilder(JsonArray) - Method in class com.bfo.json.JSRProvider
- createBoolean(boolean) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "boolean" object
- createBuffer(InputStream, long) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "buffer" object
- createBuilderFactory(Map<String, ?>) - Method in class com.bfo.json.JSRProvider
- createDiff(JsonStructure, JsonStructure) - Method in class com.bfo.json.JSRProvider
- createGenerator(OutputStream) - Method in class com.bfo.json.JSRProvider
- createGenerator(Writer) - Method in class com.bfo.json.JSRProvider
- createGeneratorFactory(Map<String, ?>) - Method in class com.bfo.json.JSRProvider
- createList() - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "list" object
- createMap() - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "map" object
- createMergeDiff(JsonValue, JsonValue) - Method in class com.bfo.json.JSRProvider
- createMergePatch(JsonValue) - Method in class com.bfo.json.JSRProvider
- createNodeSetFilter(Collection<Json>, boolean) - Static method in class com.bfo.json.JsonWriteOptions
-
Return a simple Filter that will only print nodes that are either in, or not in the specified set
- createNull() - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "null" object
- createNumber(Number) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "number" object
- createObjectBuilder() - Method in class com.bfo.json.JSRProvider
- createObjectBuilder(Map<String, Object>) - Method in class com.bfo.json.JSRProvider
- createObjectBuilder(JsonObject) - Method in class com.bfo.json.JSRProvider
- createParser(InputStream) - Method in class com.bfo.json.JSRProvider
- createParser(Reader) - Method in class com.bfo.json.JSRProvider
- createParserFactory(Map<String, ?>) - Method in class com.bfo.json.JSRProvider
- createPatch(JsonArray) - Method in class com.bfo.json.JSRProvider
- createPatchBuilder() - Method in class com.bfo.json.JSRProvider
- createPatchBuilder(JsonArray) - Method in class com.bfo.json.JSRProvider
- createPointer(String) - Method in class com.bfo.json.JSRProvider
- createReader(InputStream) - Method in class com.bfo.json.JSRProvider
- createReader(Reader) - Method in class com.bfo.json.JSRProvider
- createReaderFactory(Map<String, ?>) - Method in class com.bfo.json.JSRProvider
- createString(Reader, long) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "string" object
- createUndefined() - Method in class com.bfo.json.JsonReadOptions.Filter
-
Create a new "undefined" object
- createValue(double) - Method in class com.bfo.json.JSRProvider
- createValue(int) - Method in class com.bfo.json.JSRProvider
- createValue(long) - Method in class com.bfo.json.JSRProvider
- createValue(String) - Method in class com.bfo.json.JSRProvider
- createValue(BigDecimal) - Method in class com.bfo.json.JSRProvider
- createValue(BigInteger) - Method in class com.bfo.json.JSRProvider
- createWriter(OutputStream) - Method in class com.bfo.json.JSRProvider
- createWriter(Writer) - Method in class com.bfo.json.JSRProvider
- createWriterFactory(Map<String, ?>) - Method in class com.bfo.json.JSRProvider
D
- doubleValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a double.
- doubleValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.doubleValue()
method on it, otherwise return 0 - duplicate() - Method in class com.bfo.json.Json
-
Create and return a deep copy of this Json tree.
E
- enter(Json, Object) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Called before reading each entry in a Map.
- enter(Object, Json) - Method in class com.bfo.json.JsonWriteOptions.Filter
-
Called before writing each entry in a Map, this method can control which entries from the map are written.
- equals(Object) - Method in class com.bfo.json.Json
- exit(Json, Object) - Method in class com.bfo.json.JsonReadOptions.Filter
-
Called after reading each entry in a Map.
- exit(Object, Json) - Method in class com.bfo.json.JsonWriteOptions.Filter
-
Called after writing each entry in a Map.
F
- Filter() - Constructor for class com.bfo.json.JsonReadOptions.Filter
- Filter() - Constructor for class com.bfo.json.JsonWriteOptions.Filter
- find(Json) - Method in class com.bfo.json.Json
-
Get the path from this node to the specified object, which should be a descendant of this node.
- floatValue() - Method in class com.bfo.json.Json
-
Return the value of this node as an float.
- floatValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.floatValue()
method on it, otherwise return 0 - fromCOSEKey(Json) - Static method in class com.bfo.json.JWK
-
Convert a COSE Key (https://datatracker.ietf.org/doc/html/rfc9052#section-7) to a JWT version
- fromJson(Json) - Method in interface com.bfo.json.JsonFactory
-
Given a Json object, return a more specific type if this factory knows about it, otherwise return null
G
- get(Object) - Method in class com.bfo.json.Json
-
Return the specified child of this object, or null if no value exists at the specified key
- getAlgorithm() - Method in class com.bfo.json.JWK
-
Return the algorithm name, if set
- getAlgorithm() - Method in class com.bfo.json.JWT
-
Return the algorithm name.
- getAlgorithm(int) - Method in class com.bfo.json.COSE
-
Return the Signature algorithm used for the specified signature - 0 for the first signature, 1 for the second etc.
- getAudience() - Method in class com.bfo.json.JWT
-
Return the audience claim ("aud")
- getCborDiag() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "cborDiag" flag as set by
JsonWriteOptions.setCborDiag(java.lang.String)
- getCborStringCodingErrorAction() - Method in class com.bfo.json.JsonReadOptions
-
Return the CodingErrorAction set by
JsonReadOptions.setCborStringCodingErrorAction(java.nio.charset.CodingErrorAction)
is incorrect, the specified action will be performed. - getCertificates() - Method in class com.bfo.json.COSE
-
If the COSE object contains X.509 Certificates in the header, as defined by RFC9360, then return the list.
- getCertificates() - Method in class com.bfo.json.JWK
-
Return the list of X.509 certificates specified in the JWK, downloading them if required.
- getDoubleFormat() - Method in class com.bfo.json.JsonWriteOptions
-
Return the float format as set by
JsonWriteOptions.setDoubleFormat(java.lang.String)
- getExpiry() - Method in class com.bfo.json.JWT
-
Return the expiry claim ("exp"), in milliseconds since the epoch.
- getExternalProtectedAttributes() - Method in class com.bfo.json.COSE
-
Return the external protected attributes, as set by
COSE.setExternalProtectedAttributes(com.bfo.json.Json)
- getFactory() - Method in class com.bfo.json.Json
-
Return the default JsonFactory, as set by
Json.setFactory(com.bfo.json.JsonFactory)
- getFastStringLength() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "fastStringLength" as set by
JsonReadOptions.setFastStringLength(int)
- getFilter() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the Filter as set by
JsonReadOptions.setFilter(com.bfo.json.JsonReadOptions.Filter)
- getFilter() - Method in class com.bfo.json.JsonWriteOptions
-
Return the Filter as set by
JsonWriteOptions.setFilter(com.bfo.json.JsonWriteOptions.Filter)
- getFloatFormat() - Method in class com.bfo.json.JsonWriteOptions
-
Return the float format as set by
JsonWriteOptions.setFloatFormat(java.lang.String)
- getHeader() - Method in class com.bfo.json.JWT
-
Return the header object.
- getId() - Method in class com.bfo.json.JWK
-
Return the key id, if set.
- getIssuedAt() - Method in class com.bfo.json.JWT
-
Return the issued at claim ("iat") in milliseconds since the epoch.
- getIssuer() - Method in class com.bfo.json.JWT
-
Return the issuer claim ("iss")
- getKeys() - Method in class com.bfo.json.JWK
-
Retrieve the Keys specified in this JWK.
- getListeners() - Method in class com.bfo.json.Json
-
Return the read-only set of listeners on this class.
- getMaxArraySize() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "maxArraySize" field as set by
JsonWriteOptions.setMaxArraySize(int)
- getMaxStringLength() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "maxStringLength" field as set by
JsonWriteOptions.setMaxStringLength(int)
- getNotBefore() - Method in class com.bfo.json.JWT
-
Return the not before claim ("nbf") in milliseconds since the epoch.
- getNumSignatures() - Method in class com.bfo.json.COSE
-
Return the number of Sigantures on this COSE object
- getOps() - Method in class com.bfo.json.JWK
-
Return the key operations, if set
- getPath(String) - Method in class com.bfo.json.Json
-
Return the specified descendant of this object, or null if no value exists at the specified path.
- getPayload() - Method in class com.bfo.json.COSE
-
Get the payload from this COSE object.
- getPayload() - Method in class com.bfo.json.JWT
-
Return the payload object.
- getPrivateKey() - Method in class com.bfo.json.JWK
-
Return the PrivateKey from
JWK.getKeys()
, or null if none exists - getProtectedAttributes() - Method in class com.bfo.json.COSE
-
Return the protected attributes, which may be null
- getProvider() - Method in class com.bfo.json.COSE
-
Return the Provider set by
COSE.setProvider(java.security.Provider)
- getProvider() - Method in class com.bfo.json.JWK
-
Return the Provider set by
JWK.setProvider(java.security.Provider)
- getProvider() - Method in class com.bfo.json.JWT
-
Return the Provider set by
JWT.setProvider(java.security.Provider)
- getPublicKey() - Method in class com.bfo.json.JWK
-
Return the PublicKey from
JWK.getKeys()
, or null if none exists - getSecretKey() - Method in class com.bfo.json.JWK
-
Return the SecretKey from
JWK.getKeys()
, or null if none exists - getSignature() - Method in class com.bfo.json.JWT
-
Return the signature object.
- getSubject() - Method in class com.bfo.json.JWT
-
Return the subject claim ("sub")
- getTag() - Method in class com.bfo.json.Json
-
Return the tag for this item.
- getUniqueID() - Method in class com.bfo.json.JWT
-
Return the unique id claim ("jti")
- getUnprotectedAttributes() - Method in class com.bfo.json.COSE
-
Return the unprotected attributes, which may be null
- getUse() - Method in class com.bfo.json.JWK
-
Return the key use, if set.
H
- has(Object) - Method in class com.bfo.json.Json
-
If object is a Json object, return true if this object is a list or map, and contains that value.
- hashCode() - Method in class com.bfo.json.Json
-
Return a hashCode based on the
Json.value()
- hasPath(String) - Method in class com.bfo.json.Json
-
Return true if this object has a non-null/non-undefined descendant at the specified path.
I
- initialize() - Method in class com.bfo.json.JsonReadOptions.Filter
-
Called once when the Json reading begins
- initialize(Json) - Method in class com.bfo.json.JsonWriteOptions.Filter
-
Called once when the Json writing begins
- intValue() - Method in class com.bfo.json.Json
-
Return the value of this node as an integer.
- intValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.intValue()
method on it, otherwise return 0 - isAllowComments() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "comments" flag as set by
JsonReadOptions.setAllowComments(boolean)
- isAllowNaN() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "allowNaN" flag as set by
JsonWriteOptions.setAllowNaN(boolean)
- isAllowTrailingComma() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "trailingComma" flag as set by
JsonReadOptions.setAllowTrailingComma(boolean)
- isAllowUnquotedKey() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "unquotedKey" flag as set by
JsonReadOptions.setAllowUnquotedKey(boolean)
- isBase64Standard() - Method in class com.bfo.json.JsonWriteOptions
-
Return the value of the "base64standard" flag as set by
JsonWriteOptions.setBase64Standard(boolean)
- isBigDecimal() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "bigDecimal" flag as set by
JsonReadOptions.setBigDecimal(boolean)
- isBoolean() - Method in class com.bfo.json.Json
-
Return true if this node is a "boolean"
- isBoolean(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "boolean".
- isBuffer() - Method in class com.bfo.json.Json
-
Return true if this node is a "buffer"
- isBuffer(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "buffer".
- isCborDiag() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "CBOR-Diag" flag as set by
JsonReadOptions.setCborDiag(boolean)
- isCborFailOnUnknownTypes() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "cborFailOnUnknownTypes" flag, as set by
JsonReadOptions.setCborFailOnUnknownTypes(boolean)
- isContextFree() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "nocontext" flag as set by
JsonReadOptions.setContextFree(boolean)
- isDetached() - Method in class com.bfo.json.COSE
-
Return true if the payload was set to "detached".
- isEmpty() - Method in class com.bfo.json.Json
-
Return true if this node is a number, string, buffer, boolean, null or an empty map or list.
- isFailOnComplexKeys() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "failOnComplexKeys" flag, as set by
JsonReadOptions.setFailOnComplexKeys(boolean)
- isInitialized() - Method in class com.bfo.json.COSE
-
Return true if this COSE object is initialized.
- isList() - Method in class com.bfo.json.Json
-
Return true if this node is a "list"
- isList(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "list".
- isLooseEmptyStrings() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "looseEmptyString" flag as set by
JsonReadOptions.setLooseEmptyStrings(boolean)
- isMap() - Method in class com.bfo.json.Json
-
Return true if this node is a "map"
- isMap(Object) - Method in class com.bfo.json.Json
-
Return true if the specified wchild of this object is of type "map".
- isNFC() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "nfc" flag as set by
JsonReadOptions.setNFC(boolean)
- isNFC() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "nfc" flag as set by
JsonWriteOptions.setNFC(boolean)
- isNull() - Method in class com.bfo.json.Json
-
Return true if this node is null
- isNull(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "null".
- isNumber() - Method in class com.bfo.json.Json
-
Return true if this node is a "number"
- isNumber(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "number".
- isPretty() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "pretty" flag as set by
JsonWriteOptions.setPretty(boolean)
- isSorted() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "sorted" flag as set by
JsonWriteOptions.setSorted(boolean)
- isSpaceAfterColon() - Method in class com.bfo.json.JsonWriteOptions
-
Return the "spaceAfterColon" flag as set by
JsonWriteOptions.setSpaceAfterColon(boolean)
- isStrictTypes() - Method in class com.bfo.json.JsonReadOptions
-
Return the value of the "strictTypes" flag as set by
JsonReadOptions.setStrictTypes(boolean)
- isString() - Method in class com.bfo.json.Json
-
Return true if this node is a "string"
- isString(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "string".
- isUndefined() - Method in class com.bfo.json.Json
-
Return true if this node is undefined.
- isUndefined(Object) - Method in class com.bfo.json.Json
-
Return true if the specified child of this object is of type "undefined".
- isValidAt(long) - Method in class com.bfo.json.JWT
-
Check the token was valid at the specified time.
J
- Json - Class in com.bfo.json
-
JSON (and now CBOR/Msgpack) implementation that tries to be simple, complete, fast and follow the principle ofi least surprise.
- Json(Object) - Constructor for class com.bfo.json.Json
-
Create a new Json object that represents the specified object.
- Json(Object, JsonFactory) - Constructor for class com.bfo.json.Json
-
Create a new Json object that represents the specified object.
- jsonEvent(Json, JsonEvent) - Method in interface com.bfo.json.JsonListener
-
Called when a JsonEvent was fired on the object the listener was added to or one of its descendants.
- JsonEvent - Class in com.bfo.json
-
An event object which notifies a
JsonListener
of changes to a Json object. - JsonEvent(Json, Json) - Constructor for class com.bfo.json.JsonEvent
-
Create a new JsonEvent
- JsonFactory - Interface in com.bfo.json
-
A Factory interface that can be implemented to convert more complex types to/from Json if required.
- JsonListener - Interface in com.bfo.json
-
An interface that can be implemented to monitor changes to the Json object tree.
- JsonReadOptions - Class in com.bfo.json
-
This class controls the details of the
Json.read()
call. - JsonReadOptions() - Constructor for class com.bfo.json.JsonReadOptions
- JsonReadOptions.Filter - Class in com.bfo.json
-
A Filter which can be applied during reading of data.
- JsonWriteOptions - Class in com.bfo.json
-
This class determines how the Json written with
Json.write()
is formatted. - JsonWriteOptions() - Constructor for class com.bfo.json.JsonWriteOptions
- JsonWriteOptions.Filter - Class in com.bfo.json
-
A Filter which can be used to restrict which nodes are written, or to override the source of data for some nodes
- JSRProvider - Class in com.bfo.json
-
The JsonProvider implementation that provider the JSON-P (JSR374) implementation.
- JSRProvider() - Constructor for class com.bfo.json.JSRProvider
- JWK - Class in com.bfo.json
-
A class representing a single "JSON Web Key", a JSON representation of an asymmetric key/keypair, or a symmetric key.
- JWK() - Constructor for class com.bfo.json.JWK
-
Create a new, empty JWK
- JWK(byte[], String) - Constructor for class com.bfo.json.JWK
-
Create a new JWK key from a DER encoded secret, public or private key, or PEM encoded versions of public, private or both keys
- JWK(Json) - Constructor for class com.bfo.json.JWK
-
Create a new JWK from the specified Json, sharing its content
- JWK(Key) - Constructor for class com.bfo.json.JWK
-
Create a new JWK from the supplied Key
- JWK(KeyPair) - Constructor for class com.bfo.json.JWK
-
Create a new JWK from the supplied KeyPair
- JWT - Class in com.bfo.json
-
A trivial JWT (Json Web Token) implementation Supports all signature algorithms supported by
JWK
. - JWT() - Constructor for class com.bfo.json.JWT
-
Create a new JWT with no payload and the "none" algorithm.
- JWT(Json) - Constructor for class com.bfo.json.JWT
-
Create a new JWT with the specified payload and the "none" algorithm.
- JWT(CharSequence) - Constructor for class com.bfo.json.JWT
-
Create a new JWT from the encoded representation
L
- leafIterator() - Method in class com.bfo.json.Json
-
Return an Iterator that will descend through every leaf node under this object in a depth-first traveral.
- listValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a list.
- listValue(Object) - Method in class com.bfo.json.Json
-
If the specified wchild of this object exists call the
Json.listValue()
method on it, otherwise return null - longValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a long.
- longValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.longValue()
method on it, otherwise return 0
M
- mapValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a map.
- mapValue(Object) - Method in class com.bfo.json.Json
-
If the specified descendant of this object exists call the
Json.mapValue()
method on it, otherwise return null
N
- numberValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a Number.
- numberValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.intValue()
method on it, otherwise return null
O
- objectValue() - Method in class com.bfo.json.Json
-
Return this Json value as a plain object.
P
- parent() - Method in class com.bfo.json.Json
-
Get the parent of this node, if known
- put(Object, Object) - Method in class com.bfo.json.Json
-
Put the specified value into this object with the specified key.
- putPath(String, Object) - Method in class com.bfo.json.Json
-
Put the specified value into this object or one of its descendants by parsing the specified path.
R
- read(InputStream, JsonReadOptions) - Static method in class com.bfo.json.Json
-
Read a Json object from the specified InputStream.
- read(Reader, JsonReadOptions) - Static method in class com.bfo.json.Json
-
Read a Json object from the specified Reader.
- read(CharSequence) - Static method in class com.bfo.json.Json
-
Read a Json object from the specified String.
- readCbor(InputStream, JsonReadOptions) - Static method in class com.bfo.json.Json
-
Read a CBOR formatted object from the specified InputStream.
- readCbor(ByteBuffer, JsonReadOptions) - Static method in class com.bfo.json.Json
-
Read a CBOR formatted object from the specified ByteBuffer.
- readMsgpack(InputStream, JsonReadOptions) - Static method in class com.bfo.json.Json
-
Read a Msgpack formatted object from the specified InputStream.
- readMsgpack(ByteBuffer, JsonReadOptions) - Static method in class com.bfo.json.Json
-
Read a Msgpack formatted object from the specified ByteBuffer.
- remove(Object) - Method in class com.bfo.json.Json
-
Remove the item at the specified path from this object or one of its descendants.
- removeListener(JsonListener) - Method in class com.bfo.json.Json
-
Remove a
JsonListener
from this class - removePath(String) - Method in class com.bfo.json.Json
-
Remove the item at the specified path from this object or one of its descendants.
S
- setAllowComments(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Whether to allow comments in the JSON input, eg
["a"]/*comment*/
. - setAllowNaN(boolean) - Method in class com.bfo.json.JsonWriteOptions
-
Whether to allow NaN and Infinite values in the output.
- setAllowTrailingComma(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Whether to allow trailing commas in the JSON input, eg
["a",]
. - setAllowUnquotedKey(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Whether to allow unquotedKey keys in the JSON input.
- setAudience(List<String>) - Method in class com.bfo.json.JWT
-
Set the audience claim ("aud")
- setBase64Standard(boolean) - Method in class com.bfo.json.JsonWriteOptions
-
When encoding a "buffer" value in JSON, it will be encoded as Base64.
- setBigDecimal(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Set whether real numbers that cannot be guaranteed to be exactly the same when stored as a
Double
should be stored as aBigDecimal
. - setCborDiag(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Set the parser to recognise the "CBOR-Diag" variation of Json
- setCborDiag(String) - Method in class com.bfo.json.JsonWriteOptions
-
When dumping CBOR data, this flag can be set to use the "CBOR-Diag" format from RFC8949.
- setCborFailOnUnknownTypes(boolean) - Method in class com.bfo.json.JsonReadOptions
-
When reading a CBOR stream that contains undefined, but technically valid types, by default these will be collapsed to null with a tag set on them to indicate the original type.
- setCborStringCodingErrorAction(CodingErrorAction) - Method in class com.bfo.json.JsonReadOptions
-
When reading CBOR/Msgpack, if a String is encountered where the UTF-8 encoding is incorrect, the specified action will be performed.
- setCertificates(List<X509Certificate>) - Method in class com.bfo.json.COSE
-
Set a list of X.509 Certificates to be included in the COSE header, or null.
- setCertificates(List<X509Certificate>, String) - Method in class com.bfo.json.JWK
-
Set the list of X.509 certificates specified in the JWK, either as a url or inline.
- setContextFree(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Whether to turn off tracking of the line, column and context of the reader when reading from a file, which is used when reporting errors.
- setDoubleFormat(String) - Method in class com.bfo.json.JsonWriteOptions
-
The String format to use when formatting a double.
- setExpiry(long) - Method in class com.bfo.json.JWT
-
Set the expiry claim ("exp"), in milliseconds since the epoch.
- setExternalProtectedAttributes(Json) - Method in class com.bfo.json.COSE
-
Set the external protected attributes on this object, which may be null.
- setFactory(JsonFactory) - Method in class com.bfo.json.Json
-
Set the default JsonFactory for this object and its descendants.
- setFailOnComplexKeys(boolean) - Method in class com.bfo.json.JsonReadOptions
-
When reading CBOR/Msgpack and a map key is encountered that is "complex", fail rather than converting it silently to a String.
- setFastStringLength(int) - Method in class com.bfo.json.JsonReadOptions
-
Set the value of the "fastStringLength" value - strings loaded from a binary source less than this value will be loaded directly into memory, whereas above this length they will be streamed.
- setFilter(JsonReadOptions.Filter) - Method in class com.bfo.json.JsonReadOptions
-
Set the
JsonReadOptions.Filter
that will be used to convert objects when reading - setFilter(JsonWriteOptions.Filter) - Method in class com.bfo.json.JsonWriteOptions
-
Set a Filter on the writer, which can be used to restrict which nodes are written
- setFloatFormat(String) - Method in class com.bfo.json.JsonWriteOptions
-
The String format to use when formatting a float.
- setId(String) - Method in class com.bfo.json.JWK
-
Set the key id
- setIssuedAt(long) - Method in class com.bfo.json.JWT
-
Set the issued at claim ("iat") in milliseconds since the epoch.
- setIssuer(String) - Method in class com.bfo.json.JWT
-
Set the issuer claim ("iss")
- setKeys(Collection<Key>) - Method in class com.bfo.json.JWK
-
Set the Key on this JWK.
- setLooseEmptyStrings(boolean) - Method in class com.bfo.json.JsonReadOptions
-
When the
strictTypes
flag is not set, this flag will determine whether empty strings evaluate to zero when treated as a number and false when treated as a boolean. - setMaxArraySize(int) - Method in class com.bfo.json.JsonWriteOptions
-
Set the maximum number of items to print in an array.
- setMaxStringLength(int) - Method in class com.bfo.json.JsonWriteOptions
-
Set the maximum length of a string.
- setNFC(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Set whether to normalize all Strings (including map keys) to Unicode
normal form C
- setNFC(boolean) - Method in class com.bfo.json.JsonWriteOptions
-
Set whether to normalize all Strings (including map keys) to Unicode
normal form C
when writing. - setNotBefore(long) - Method in class com.bfo.json.JWT
-
Set the not before claim ("nbf") in milliseconds since the epoch.
- setOps(Collection<String>) - Method in class com.bfo.json.JWK
-
Set the key operations
- setPayload(ByteBuffer, boolean) - Method in class com.bfo.json.COSE
-
Set the payload to sign.
- setPretty(boolean) - Method in class com.bfo.json.JsonWriteOptions
-
Whether to pretty-print the Json, using newlines and indentation.
- setProtectedAttributes(Json) - Method in class com.bfo.json.COSE
-
Set the protected attributes on this object.
- setProvider(Provider) - Method in class com.bfo.json.COSE
-
Set the Provider to be used for any cryptographic operations
- setProvider(Provider) - Method in class com.bfo.json.JWK
-
Set the Provider to be used for any cryptographic operations
- setProvider(Provider) - Method in class com.bfo.json.JWT
-
Set the Provider to be used for any cryptographic operations
- setSorted(boolean) - Method in class com.bfo.json.JsonWriteOptions
-
Whether to sort the keys in each map alphabetically when writing.
- setSpaceAfterColon(boolean) - Method in class com.bfo.json.JsonWriteOptions
-
Whether to add a space after each colon in Json serialization.
- setStrictTypes(boolean) - Method in class com.bfo.json.JsonReadOptions
-
Determines whether objects read by the JsonReader will be loosely typed.
- setSubject(String) - Method in class com.bfo.json.JWT
-
Set the subject claim ("sub")
- setTag(long) - Method in class com.bfo.json.Json
-
Set the tag for this item.
- setUniqueID(String) - Method in class com.bfo.json.JWT
-
Set the unique id claim ("jti")
- setUnprotectedAttributes(Json) - Method in class com.bfo.json.COSE
-
Set the unprotected attributes on this object.
- setUse(String) - Method in class com.bfo.json.JWK
-
Set the key use
- setValue(Json) - Method in class com.bfo.json.Json
-
Copy the internal value from the specified Json object to this object.
- sign(Key) - Method in class com.bfo.json.JWT
-
Sign the JWT.
- sign(Key, String) - Method in class com.bfo.json.COSE
-
Sign the COSE.
- sign(Map<Key, String>) - Method in class com.bfo.json.COSE
-
Sign the COSE with multiple signatures.
- size() - Method in class com.bfo.json.Json
-
Return the size of this object, or zero if this object is a number, string, buffer, boolean or null.
- sort() - Method in class com.bfo.json.Json
-
For Json objects that are maps, sort the map keys.
- stringValue() - Method in class com.bfo.json.Json
-
Return the value of this node as a String.
- stringValue(Object) - Method in class com.bfo.json.Json
-
If the specified child of this object exists call the
Json.stringValue()
method on it, otherwise return null
T
- toCbor() - Method in class com.bfo.json.Json
-
Return a Cbor representation of this Json object.
- toCbor(JsonWriteOptions) - Method in class com.bfo.json.Json
-
Return a Cbor representation of this Json object with the specified options
- toCOSEKey() - Method in class com.bfo.json.JWK
-
Convert this JWK key to a COSE Key (https://datatracker.ietf.org/doc/html/rfc9052#section-7)
- toJson(Object) - Method in interface com.bfo.json.JsonFactory
-
Given a regular Object, return the equivalent Json object if this factory knows about it, otherwise return null.
- toString() - Method in class com.bfo.json.Json
-
Return a String representation of this Json object.
- toString() - Method in class com.bfo.json.JsonEvent
- toString() - Method in class com.bfo.json.JWT
-
Return the encoded JWT
- toString(JsonWriteOptions) - Method in class com.bfo.json.Json
-
Return a String representation of this Json object with the specified serialization options.
- type() - Method in class com.bfo.json.Json
-
Return the type of this node, which may be "number", "string", "boolean", "list", "map", "buffer", "null" or (since v5) "undefined"
U
- UNDEFINED - Static variable in class com.bfo.json.Json
-
A constant object that can be passed into the Json constructor to create a Cbor "undefined" value
V
- value() - Method in class com.bfo.json.Json
- verify(Key) - Method in class com.bfo.json.JWT
-
Verify the JWT.
- verify(PublicKey) - Method in class com.bfo.json.COSE
-
Verify a COSE that is
initialized
W
- write(Appendable, JsonWriteOptions) - Method in class com.bfo.json.Json
-
Write the Json object to the specified output
- writeCbor(OutputStream, JsonWriteOptions) - Method in class com.bfo.json.Json
-
Write the Json object in the CBOR format to the specified output
- writeMsgpack(OutputStream, JsonWriteOptions) - Method in class com.bfo.json.Json
-
Write the Json object in the Msgpack format to the specified output
All Classes and Interfaces|All Packages