AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::Utils::DocumentView Class Reference

#include <Document.h>

Public Member Functions

 DocumentView ()
 
 DocumentView (const Document &value)
 
DocumentViewoperator= (const Document &value)
 
Aws::String GetString (const Aws::String &key) const
 
Aws::String AsString () const
 
bool IsString () const
 
bool GetBool (const Aws::String &key) const
 
bool AsBool () const
 
bool IsBool () const
 
int GetInteger (const Aws::String &key) const
 
int AsInteger () const
 
bool IsIntegerType () const
 
DocumentAsInt64 (long long value)
 
int64_t GetInt64 (const Aws::String &key) const
 
int64_t AsInt64 () const
 
double GetDouble (const Aws::String &key) const
 
double AsDouble () const
 
bool IsFloatingPointType () const
 
Array< DocumentViewGetArray (const Aws::String &key) const
 
Array< DocumentViewAsArray () const
 
bool IsListType () const
 
DocumentView GetObject (const Aws::String &key) const
 
DocumentView AsObject () const
 
Aws::Map< Aws::String, DocumentViewGetAllObjects () const
 
bool IsObject () const
 
bool IsNull () const
 
bool ValueExists (const Aws::String &key) const
 
bool KeyExists (const Aws::String &key) const
 
Aws::String WriteCompact () const
 
Aws::String WriteReadable () const
 
Document Materialize () const
 

Detailed Description

Provides read-only view to an existing Document. This allows lightweight copying without making deep copies of the Document. Note: This class does not extend the lifetime of the given Document. It's your responsibility to ensure the lifetime of the Document is extended beyond the lifetime of its view.

Definition at line 225 of file Document.h.

Constructor & Destructor Documentation

◆ DocumentView() [1/2]

Aws::Utils::DocumentView::DocumentView ( )

◆ DocumentView() [2/2]

Aws::Utils::DocumentView::DocumentView ( const Document value)

Member Function Documentation

◆ AsArray()

Array<DocumentView> Aws::Utils::DocumentView::AsArray ( ) const

Returns the value of this Document as an array of DocumentView objects.

◆ AsBool()

bool Aws::Utils::DocumentView::AsBool ( ) const

Returns the value of this Document as a boolean.

◆ AsDouble()

double Aws::Utils::DocumentView::AsDouble ( ) const

Returns the value of this Document as a double precision floating-point.

◆ AsInt64() [1/2]

int64_t Aws::Utils::DocumentView::AsInt64 ( ) const

Returns the value of this Document as 64-bit integer.

◆ AsInt64() [2/2]

Document& Aws::Utils::DocumentView::AsInt64 ( long long  value)

Converts the current Document to a 64-bit integer.

◆ AsInteger()

int Aws::Utils::DocumentView::AsInteger ( ) const

Returns the value of this Document as an int.

◆ AsObject()

DocumentView Aws::Utils::DocumentView::AsObject ( ) const

Returns the value of this Document as a DocumentView object.

◆ AsString()

Aws::String Aws::Utils::DocumentView::AsString ( ) const

Returns the value of this Document as a string.

◆ GetAllObjects()

Aws::Map<Aws::String, DocumentView> Aws::Utils::DocumentView::GetAllObjects ( ) const

Reads all Document objects at the top level of this Document (does not traverse the tree any further) along with their keys.

◆ GetArray()

Array<DocumentView> Aws::Utils::DocumentView::GetArray ( const Aws::String key) const

Gets an array of DocumentView objects from this Document by its key.

◆ GetBool()

bool Aws::Utils::DocumentView::GetBool ( const Aws::String key) const

Gets a boolean value from this Document by its key.

◆ GetDouble()

double Aws::Utils::DocumentView::GetDouble ( const Aws::String key) const

Gets a double precision floating-point value from this Document by its key.

◆ GetInt64()

int64_t Aws::Utils::DocumentView::GetInt64 ( const Aws::String key) const

Gets a 64-bit integer value from this Document by its key. The value is 64-bit regardless of the platform/machine.

◆ GetInteger()

int Aws::Utils::DocumentView::GetInteger ( const Aws::String key) const

Gets an integer value from this Document by its key. The integer is of the same size as an int on the machine.

◆ GetObject()

DocumentView Aws::Utils::DocumentView::GetObject ( const Aws::String key) const

Gets a DocumentView object from this Document by its key.

◆ GetString()

Aws::String Aws::Utils::DocumentView::GetString ( const Aws::String key) const

Gets a string from this Document by its key.

◆ IsBool()

bool Aws::Utils::DocumentView::IsBool ( ) const

Tests whether the current value is a boolean.

◆ IsFloatingPointType()

bool Aws::Utils::DocumentView::IsFloatingPointType ( ) const

Tests whether the current value is a floating-point.

◆ IsIntegerType()

bool Aws::Utils::DocumentView::IsIntegerType ( ) const

Tests whether the current value is an int or int64_t. Returns false if the value is floating-point.

◆ IsListType()

bool Aws::Utils::DocumentView::IsListType ( ) const

Tests whether the current value is a Document array.

◆ IsNull()

bool Aws::Utils::DocumentView::IsNull ( ) const

Tests whether the current value is NULL.

◆ IsObject()

bool Aws::Utils::DocumentView::IsObject ( ) const

Tests whether the current value is a Document object.

◆ IsString()

bool Aws::Utils::DocumentView::IsString ( ) const

Tests whether the current value is a string.

◆ KeyExists()

bool Aws::Utils::DocumentView::KeyExists ( const Aws::String key) const

Tests whether a key exists at the current Document level.

◆ Materialize()

Document Aws::Utils::DocumentView::Materialize ( ) const

Creates a deep copy of the JSON value rooted in the current JSON view.

◆ operator=()

DocumentView& Aws::Utils::DocumentView::operator= ( const Document value)

◆ ValueExists()

bool Aws::Utils::DocumentView::ValueExists ( const Aws::String key) const

Tests whether a value exists at the current Document level for the given key. Returns true if a value has been found and its value is not null, false otherwise.

◆ WriteCompact()

Aws::String Aws::Utils::DocumentView::WriteCompact ( ) const

Writes the current Document view without whitespace characters starting at the current level to a string.

◆ WriteReadable()

Aws::String Aws::Utils::DocumentView::WriteReadable ( ) const

Writes the current Document view to a string in a human friendly format.


The documentation for this class was generated from the following file: