JsonDocument
Overview
Root node of json data
Location
- Reference: elements.jar
- Namespace: RemObjects.Elements.RTL
- Platforms: Cooper
constructor
constructor (not nullable JsonNode)
constructor(aRoot: not nullable JsonNode)
JsonDocument(JsonNode! aRoot)
init(_ aRoot: JsonNode)
JsonDocument(JsonNode aRoot)
Sub New(aRoot As JsonNode)
Parameters:
- aRoot:
CreateDocument
Create a new json document.
class method CreateDocument: not nullable JsonDocument
static JsonDocument! CreateDocument()
static func CreateDocument() -> JsonDocument
static JsonDocument CreateDocument()
Shared Function CreateDocument() As JsonDocument
FromBinary (not nullable array of Byte, Encoding): not nullable JsonDocument
class method FromBinary(aBinary: not nullable array of Byte; aEncoding: Encoding): not nullable JsonDocument
static JsonDocument! FromBinary(Byte[]! aBinary, Encoding aEncoding)
static func FromBinary(_ aBinary: Byte..., _ aEncoding: Encoding) -> JsonDocument
static JsonDocument FromBinary(Byte[] aBinary, Encoding aEncoding)
Shared Function FromBinary(aBinary As Byte(), aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
FromBinary (not nullable ImmutableBinary, Encoding): not nullable JsonDocument
Parse json from a binary.
class method FromBinary(aBinary: not nullable ImmutableBinary; aEncoding: Encoding): not nullable JsonDocument
static JsonDocument! FromBinary(ImmutableBinary! aBinary, Encoding aEncoding)
static func FromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument
static JsonDocument FromBinary(ImmutableBinary aBinary, Encoding aEncoding)
Shared Function FromBinary(aBinary As ImmutableBinary, aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
FromFile
Parse json from a file.
class method FromFile(aFile: not nullable File): not nullable JsonDocument
static JsonDocument! FromFile(File! aFile)
static func FromFile(_ aFile: File) -> JsonDocument
static JsonDocument FromFile(File aFile)
Shared Function FromFile(aFile As File) As JsonDocument
Parameters:
- aFile:
FromString
Parse json from a string.
class method FromString(aString: not nullable String): not nullable JsonDocument
static JsonDocument! FromString(String! aString)
static func FromString(_ aString: String) -> JsonDocument
static JsonDocument FromString(String aString)
Shared Function FromString(aString As String) As JsonDocument
Parameters:
- aString:
FromUrl
class method FromUrl(aUrl: not nullable Url): not nullable JsonDocument
static JsonDocument! FromUrl(Url! aUrl)
static func FromUrl(_ aUrl: Url) -> JsonDocument
static JsonDocument FromUrl(Url aUrl)
Shared Function FromUrl(aUrl As Url) As JsonDocument
Parameters:
- aUrl:
Item
property Item[aIndex: Integer]: JsonNode read;
JsonNode Item[Integer aIndex] { get; }
subscript Item(_ aIndex: Integer) -> JsonNode { get{} }
JsonNode Item[Integer aIndex] { __get; }
ReadOnly Property Item(aIndex As Integer) As JsonNode
Item
Creates a new json document with the given node as root element.
property Item[aKey: not nullable String]: JsonNode read write;
JsonNode Item[String! aKey] { get; set; }
subscript Item(_ aKey: String) -> JsonNode { get{} set{} }
JsonNode Item[String aKey] { __get; __set; }
Property Item(aKey As String) As JsonNode
Item
property Item[aKey: not nullable String]: Boolean write;
Boolean Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> Boolean { set{} }
Boolean Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As Boolean
Item
property Item[aKey: not nullable String]: Double write;
Double Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> Double { set{} }
Double Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As Double
Item
property Item[aKey: not nullable String]: Integer write;
Integer Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> Integer { set{} }
Integer Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As Integer
Item
property Item[aKey: not nullable String]: String write;
String Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> String { set{} }
String Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As String
Keys
Returns all keys in this document.
property Keys: not nullable Iterable<String> read;
Iterable<String>! Keys { get; }
var Keys: Iterable<String> { get{} }
Iterable<String> Keys { __get; }
ReadOnly Property Keys() As Iterable<String>
Root
Returns the root node.
property Root: not nullable JsonNode read;
JsonNode! Root { get; }
var Root: JsonNode { get{} }
JsonNode Root { __get; }
ReadOnly Property Root() As JsonNode
RootObject
Returns the root node.
property RootObject: not nullable JsonObject read;
JsonObject! RootObject { get; }
var RootObject: JsonObject { get{} }
JsonObject RootObject { __get; }
ReadOnly Property RootObject() As JsonObject
ToJson
method ToJson(aFormat: JsonFormat): String
String ToJson(JsonFormat aFormat)
func ToJson(_ aFormat: JsonFormat) -> String
String ToJson(JsonFormat aFormat)
Function ToJson(aFormat As JsonFormat) As String
Parameters:
- aFormat:
toString
method toString: PlatformString
PlatformString toString()
func toString() -> PlatformString
PlatformString toString()
Function toString() As PlatformString
TryFromBinary (array of Byte, Encoding): JsonDocument
class method TryFromBinary(aBinary: array of Byte; aEncoding: Encoding): JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding)
static func TryFromBinary(_ aBinary: Byte..., _ aEncoding: Encoding) -> JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding)
Shared Function TryFromBinary(aBinary As Byte(), aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
TryFromBinary (array of Byte, Encoding, Exception): JsonDocument
class method TryFromBinary(aBinary: array of Byte; aEncoding: Encoding; out aException: Exception): JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding, out Exception aException)
static func TryFromBinary(_ aBinary: Byte..., _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding, __out Exception aException)
Shared Function TryFromBinary(aBinary As Byte(), aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
- aException:
TryFromBinary (ImmutableBinary, Encoding): JsonDocument
Parse json from a binary.
class method TryFromBinary(aBinary: ImmutableBinary; aEncoding: Encoding): JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding)
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding)
Shared Function TryFromBinary(aBinary As ImmutableBinary, aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
TryFromBinary (ImmutableBinary, Encoding, Exception): JsonDocument
class method TryFromBinary(aBinary: ImmutableBinary; aEncoding: Encoding; out aException: Exception): JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding, out Exception aException)
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding, __out Exception aException)
Shared Function TryFromBinary(aBinary As ImmutableBinary, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
- aException:
TryFromFile (not nullable File): JsonDocument
Parse json from a file.
class method TryFromFile(aFile: not nullable File): JsonDocument
static JsonDocument TryFromFile(File! aFile)
static func TryFromFile(_ aFile: File) -> JsonDocument
static JsonDocument TryFromFile(File aFile)
Shared Function TryFromFile(aFile As File) As JsonDocument
Parameters:
- aFile:
TryFromFile (not nullable File, Exception): JsonDocument
class method TryFromFile(aFile: not nullable File; out aException: Exception): JsonDocument
static JsonDocument TryFromFile(File! aFile, out Exception aException)
static func TryFromFile(_ aFile: File, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromFile(File aFile, __out Exception aException)
Shared Function TryFromFile(aFile As File, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aFile:
- aException:
TryFromString (String): JsonDocument
Parse json from a string.
class method TryFromString(aString: String): JsonDocument
static JsonDocument TryFromString(String aString)
static func TryFromString(_ aString: String) -> JsonDocument
static JsonDocument TryFromString(String aString)
Shared Function TryFromString(aString As String) As JsonDocument
Parameters:
- aString:
TryFromString (String, Exception): JsonDocument
class method TryFromString(aString: String; out aException: Exception): JsonDocument
static JsonDocument TryFromString(String aString, out Exception aException)
static func TryFromString(_ aString: String, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromString(String aString, __out Exception aException)
Shared Function TryFromString(aString As String, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aString:
- aException:
Item
property Item[aIndex: Integer]: JsonNode read;
JsonNode Item[Integer aIndex] { get; }
subscript Item(_ aIndex: Integer) -> JsonNode { get{} }
JsonNode Item[Integer aIndex] { __get; }
ReadOnly Property Item(aIndex As Integer) As JsonNode
Item
Creates a new json document with the given node as root element.
property Item[aKey: not nullable String]: JsonNode read write;
JsonNode Item[String! aKey] { get; set; }
subscript Item(_ aKey: String) -> JsonNode { get{} set{} }
JsonNode Item[String aKey] { __get; __set; }
Property Item(aKey As String) As JsonNode
Item
property Item[aKey: not nullable String]: Boolean write;
Boolean Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> Boolean { set{} }
Boolean Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As Boolean
Item
property Item[aKey: not nullable String]: Double write;
Double Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> Double { set{} }
Double Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As Double
Item
property Item[aKey: not nullable String]: Integer write;
Integer Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> Integer { set{} }
Integer Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As Integer
Item
property Item[aKey: not nullable String]: String write;
String Item[String! aKey] { set; }
subscript Item(_ aKey: String) -> String { set{} }
String Item[String aKey] { __set; }
WriteOnly Property Item(aKey As String) As String
Keys
Returns all keys in this document.
property Keys: not nullable Iterable<String> read;
Iterable<String>! Keys { get; }
var Keys: Iterable<String> { get{} }
Iterable<String> Keys { __get; }
ReadOnly Property Keys() As Iterable<String>
Root
Returns the root node.
property Root: not nullable JsonNode read;
JsonNode! Root { get; }
var Root: JsonNode { get{} }
JsonNode Root { __get; }
ReadOnly Property Root() As JsonNode
RootObject
Returns the root node.
CreateDocument
Create a new json document.
class method CreateDocument: not nullable JsonDocument
static JsonDocument! CreateDocument()
static func CreateDocument() -> JsonDocument
static JsonDocument CreateDocument()
Shared Function CreateDocument() As JsonDocument
FromBinary (not nullable array of Byte, Encoding): not nullable JsonDocument
class method FromBinary(aBinary: not nullable array of Byte; aEncoding: Encoding): not nullable JsonDocument
static JsonDocument! FromBinary(Byte[]! aBinary, Encoding aEncoding)
static func FromBinary(_ aBinary: Byte..., _ aEncoding: Encoding) -> JsonDocument
static JsonDocument FromBinary(Byte[] aBinary, Encoding aEncoding)
Shared Function FromBinary(aBinary As Byte(), aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
FromBinary (not nullable ImmutableBinary, Encoding): not nullable JsonDocument
Parse json from a binary.
class method FromBinary(aBinary: not nullable ImmutableBinary; aEncoding: Encoding): not nullable JsonDocument
static JsonDocument! FromBinary(ImmutableBinary! aBinary, Encoding aEncoding)
static func FromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument
static JsonDocument FromBinary(ImmutableBinary aBinary, Encoding aEncoding)
Shared Function FromBinary(aBinary As ImmutableBinary, aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
FromFile
Parse json from a file.
class method FromFile(aFile: not nullable File): not nullable JsonDocument
static JsonDocument! FromFile(File! aFile)
static func FromFile(_ aFile: File) -> JsonDocument
static JsonDocument FromFile(File aFile)
Shared Function FromFile(aFile As File) As JsonDocument
Parameters:
- aFile:
FromString
Parse json from a string.
class method FromString(aString: not nullable String): not nullable JsonDocument
static JsonDocument! FromString(String! aString)
static func FromString(_ aString: String) -> JsonDocument
static JsonDocument FromString(String aString)
Shared Function FromString(aString As String) As JsonDocument
Parameters:
- aString:
FromUrl
class method FromUrl(aUrl: not nullable Url): not nullable JsonDocument
static JsonDocument! FromUrl(Url! aUrl)
static func FromUrl(_ aUrl: Url) -> JsonDocument
static JsonDocument FromUrl(Url aUrl)
Shared Function FromUrl(aUrl As Url) As JsonDocument
Parameters:
- aUrl:
TryFromBinary (array of Byte, Encoding): JsonDocument
class method TryFromBinary(aBinary: array of Byte; aEncoding: Encoding): JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding)
static func TryFromBinary(_ aBinary: Byte..., _ aEncoding: Encoding) -> JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding)
Shared Function TryFromBinary(aBinary As Byte(), aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
TryFromBinary (array of Byte, Encoding, Exception): JsonDocument
class method TryFromBinary(aBinary: array of Byte; aEncoding: Encoding; out aException: Exception): JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding, out Exception aException)
static func TryFromBinary(_ aBinary: Byte..., _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromBinary(Byte[] aBinary, Encoding aEncoding, __out Exception aException)
Shared Function TryFromBinary(aBinary As Byte(), aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
- aException:
TryFromBinary (ImmutableBinary, Encoding): JsonDocument
Parse json from a binary.
class method TryFromBinary(aBinary: ImmutableBinary; aEncoding: Encoding): JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding)
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding) -> JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding)
Shared Function TryFromBinary(aBinary As ImmutableBinary, aEncoding As Encoding) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
TryFromBinary (ImmutableBinary, Encoding, Exception): JsonDocument
class method TryFromBinary(aBinary: ImmutableBinary; aEncoding: Encoding; out aException: Exception): JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding, out Exception aException)
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aEncoding: Encoding, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromBinary(ImmutableBinary aBinary, Encoding aEncoding, __out Exception aException)
Shared Function TryFromBinary(aBinary As ImmutableBinary, aEncoding As Encoding, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aBinary:
- aEncoding:
- aException:
TryFromFile (not nullable File): JsonDocument
Parse json from a file.
class method TryFromFile(aFile: not nullable File): JsonDocument
static JsonDocument TryFromFile(File! aFile)
static func TryFromFile(_ aFile: File) -> JsonDocument
static JsonDocument TryFromFile(File aFile)
Shared Function TryFromFile(aFile As File) As JsonDocument
Parameters:
- aFile:
TryFromFile (not nullable File, Exception): JsonDocument
class method TryFromFile(aFile: not nullable File; out aException: Exception): JsonDocument
static JsonDocument TryFromFile(File! aFile, out Exception aException)
static func TryFromFile(_ aFile: File, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromFile(File aFile, __out Exception aException)
Shared Function TryFromFile(aFile As File, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aFile:
- aException:
TryFromString (String): JsonDocument
Parse json from a string.
class method TryFromString(aString: String): JsonDocument
static JsonDocument TryFromString(String aString)
static func TryFromString(_ aString: String) -> JsonDocument
static JsonDocument TryFromString(String aString)
Shared Function TryFromString(aString As String) As JsonDocument
Parameters:
- aString:
TryFromString (String, Exception): JsonDocument
class method TryFromString(aString: String; out aException: Exception): JsonDocument
static JsonDocument TryFromString(String aString, out Exception aException)
static func TryFromString(_ aString: String, _ aException: Exception) -> JsonDocument
static JsonDocument TryFromString(String aString, __out Exception aException)
Shared Function TryFromString(aString As String, <OutAttribute> ByRef aException As Exception) As JsonDocument
Parameters:
- aString:
- aException:
constructor
constructor (not nullable JsonNode)
constructor(aRoot: not nullable JsonNode)
JsonDocument(JsonNode! aRoot)
init(_ aRoot: JsonNode)
JsonDocument(JsonNode aRoot)
Sub New(aRoot As JsonNode)
Parameters:
- aRoot:
ToJson
method ToJson(aFormat: JsonFormat): String
String ToJson(JsonFormat aFormat)
func ToJson(_ aFormat: JsonFormat) -> String
String ToJson(JsonFormat aFormat)
Function ToJson(aFormat As JsonFormat) As String
Parameters:
- aFormat:
toString