Namespace: OpenEdge.Core
Type: Class EncodedString
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object
Implements: Ccs.Common.Support.ILongcharHolder, Progress.Collections.IHashable


Copyright (c) 2021, 2023 by Progress Software Corporation. All rights reserved.
File:EncodedString
Purpose:Encodes a clear-text string as either OECH1, ODEB1 or NOPR0 (cleartext)
Author(s):pjudge
Created:2020-12-06
Notes:- The class is final to prevent unintentional exposure of the value
- The Value property must never use a setter implementation
- The Value property must never be overridden (not available in 12.4 but may be a future feature)
- The Value must never be passed in via constructor argument, or in to any method
- This class is NOT serializable because we cannot guarantee that the Value has been encoded,
nor that the Value getter is called
/* A private list of the encoding names. Cached once per session, on demand. Used by the Value getter



Method Summary
  Options Name Purpose
  LOGICAL Equals (Object)
  INTEGER HashCode () /* Hashing method for creating a proper index for use with Progress.Collections.HashMap @return integer Result of the hash-code method using this object's comparable value(s) */
  CHARACTER ToString ()

Constructor Summary
  Options Name Purpose
  EncodedString () /* Default constructor. */
  EncodedString (EncodingTypeEnum) /* Constructor. @param EncodingTypeEnum The encoding to use */

Property Summary
  Options Name Purpose
  OpenEdge.Core.EncodingTypeEnum Encoding
  CHARACTER EncodingNames
  LONGCHAR Value


Method Detail
Top

LOGICAL Equals (Object)

Parameters:
pRef Progress.Lang.Object
 
Returns LOGICAL
 
Top

INTEGER HashCode ()

/* Hashing method for creating a proper index for use with Progress.Collections.HashMap
Returns INTEGER
  integer Result of the hash-code method using this object's comparable value(s)
Top

CHARACTER ToString ()

Returns CHARACTER
 


Constructor Detail
Top

EncodedString ()

/* Default constructor.
Top

EncodedString (EncodingTypeEnum)

/* Constructor.
Parameters:
pEncoding OpenEdge.Core.EncodingTypeEnum
 


Property Detail
Top

OpenEdge.Core.EncodingTypeEnum Encoding

Returns OpenEdge.Core.EncodingTypeEnum
 
Top

CHARACTER EncodingNames

Returns CHARACTER
 
Top

LONGCHAR Value

Returns LONGCHAR