Namespace: OpenEdge.Net.HTTP.Filter.Payload
Type: Class JsonEntityWriter
Parent Classes:
Inherits: OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Copyright (c) 2015-2019, 2021 by Progress Software Corporation. All rights reserved.
File:JsonEntityWriter
Author(s):pjudge
Created:Thu Jan 29 10:47:13 EST 2015
Notes:- Write() operations are destructive (they replace the existing
Entity).



Method Summary
  Options Name Purpose
  Close () /* Closes the writer */
  Open () /* Opens the writer */
  INT64 Write (character) /** Write data to/from the message @param character Data to write @return int64 The number ofbytes written */
  Progress.Json.ObjectModel.JsonObject Write (Cookie) /* Writes an HTTP Cookie into a JSON property & value @param Cookie THe cookie to write */
  INT64 Write (handle) /** Write data to/from the message @param handle Data to write @return int64 The number ofbytes written */
  Progress.Json.ObjectModel.JsonObject Write (HttpHeader) /* Writes an HTTP header into a JSON property & value @param HttpHeader The header to write */
  INT64 Write (longchar) /** Write data to/from the message @param longchar Data to write @return int64 The number ofbytes written */
  INT64 Write (memptr) /** Write data to/from the message @param memptr Data to write @return int64 The number ofbytes written */
  INT64 Write (Object) /** Write data to/from the message @param Progress.Lang.Object Data to write @return int64 The number ofbytes written @throws P.L.AppError if an type is not supported */
  WriteError (Error)
  INT64 WriteHandle (handle) /** Write data to/from the message @param handle Data to write @return int64 The number ofbytes written */
  WriteMap (IMap)
  WriteTuple (Object, Object) /* Writes a tuple (key-value pair) as a JSON property & value @param Progress.Lang.Object The key value - property name (required) @param Progress.Lang.Object A value to be written for teh proeprty. May be null. */

Constructor Summary
  Options Name Purpose
  JsonEntityWriter () /* Default constructor */
  JsonEntityWriter (Class) /** Default constructor. */

Method Detail
Top

Close ()

/* Closes the writer
Top

Open ()

/* Opens the writer
Top

INT64 Write (character)

Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
 
Returns INT64
  int64 The number ofbytes written
Top

Progress.Json.ObjectModel.JsonObject Write (Cookie)

/* Writes an HTTP Cookie into a JSON property & value
Parameters:
pCookie OpenEdge.Net.HTTP.Cookie
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

INT64 Write (handle)

Purpose: Write data to/from the message
Parameters:
phData HANDLE
 
Returns INT64
  int64 The number ofbytes written
Top

Progress.Json.ObjectModel.JsonObject Write (HttpHeader)

/* Writes an HTTP header into a JSON property & value
Parameters:
pHeader OpenEdge.Net.HTTP.HttpHeader
 
Returns Progress.Json.ObjectModel.JsonObject
 
Top

INT64 Write (longchar)

Purpose: Write data to/from the message
Parameters:
pcData LONGCHAR
 
Returns INT64
  int64 The number ofbytes written
Top

INT64 Write (memptr)

Purpose: Write data to/from the message
Parameters:
pmData OpenEdge.Core.Memptr
 
Returns INT64
  int64 The number ofbytes written
Top

INT64 Write (Object)

Purpose: Write data to/from the message
@throws P.L.AppError if an type is not supported
Parameters:
poData Progress.Lang.Object
 
Returns INT64
  int64 The number ofbytes written
Top

WriteError (Error)

Parameters:
poError Progress.Lang.Error
 
Top

INT64 WriteHandle (handle)

Purpose: Write data to/from the message
Parameters:
phData HANDLE
 
Returns INT64
  int64 The number ofbytes written
Top

WriteMap (IMap)

Parameters:
pValue OpenEdge.Core.Collections.IMap
 
Top

WriteTuple (Object, Object)

/* Writes a tuple (key-value pair) as a JSON property & value
Parameters:
pKey Progress.Lang.Object
 
pValue Progress.Lang.Object
 


Constructor Detail
Top

JsonEntityWriter ()

/* Default constructor
Top

JsonEntityWriter (Class)

Purpose: Default constructor.
Parameters:
pType Progress.Lang.Class