Namespace: OpenEdge.Core.Util
Class
Token
Parent classes:
Progress.Lang.Object
OpenEdge.Core.Util.Token

Inherits: Progress.Lang.Object

Copyright (c) 2019, 2022 by Progress Software Corporation. All rights reserved.
File:Token
Purpose:Represents a token - group, arg and value. Only the value is
mutable
Author(s):pjudge
Created:2019-01-31
/* (mandatory) The token group being resolved




Method Summary
Options Name Purpose
INTEGER CompareTo (Token) /* Comparison method, used by SortedSet's default comparer - If the returned value is less than 0 (zero), then the current object sorts before the object passed in. - If the returned value equals 0 (zero), then the current object occupies the same position in the sort order. - If the returned value is greater than 0 (zero), then the current object sorts after the object passed in. @param Token The object to compare to. @return integer 0 = same object +1 = sorts after -1 = sorts before */
LOGICAL Equals (Object)
OpenEdge.Core.Util.Token Parse (character) /* Parses a token string (group.arg.sub-arg) into a Token object If the token starts with "?" then - the AllowUnknownValue property is set to TRUE - the ? is stripped off the group name So parsing "?cp.uid" results in grp=cp, arg=uid, as does parsing "cp.uid" @param character A complete string token @return Token A token instance */
CHARACTER ToString ()

Constructor Summary
Options Name Purpose
Token (character, character) /* Constructor. @param character (mandatory) The Token group (not null or empty) @param character (mandatory) The Token argument (not null) */
Token (character, character, logical) /* Constructor. @param character (mandatory) The Token group (not null or empty) @param character (mandatory) The Token argument (not null) @param logical (mandatory) Whether the unknown value is a valid value */

Property Summary
Options Name Purpose
LOGICAL AllowUnknownValue
CHARACTER Arg
CHARACTER Group
CHARACTER Value


Method Detail
Top

INTEGER CompareTo (Token)
/* Comparison method, used by SortedSet's default comparer
- If the returned value is less than 0 (zero), then the current object sorts before the object passed in.
- If the returned value equals 0 (zero), then the current object occupies the same position in the sort order.
- If the returned value is greater than 0 (zero), then the current object sorts after the object passed in.
+1 = sorts after
-1 = sorts before
Parameters:
pOther OpenEdge.Core.Util.Token
Returns INTEGER
integer 0 = same object
Top

LOGICAL Equals (Object)
Parameters:
pCompare Progress.Lang.Object
Returns LOGICAL
Top

OpenEdge.Core.Util.Token Parse (character)
/* Parses a token string (group.arg.sub-arg) into a Token object
If the token starts with "?" then
- the AllowUnknownValue property is set to TRUE
- the ? is stripped off the group name
So parsing "?cp.uid" results in grp=cp, arg=uid, as does parsing "cp.uid"
Parameters:
pToken CHARACTER
Returns OpenEdge.Core.Util.Token
Token A token instance
Top

CHARACTER ToString ()
Returns CHARACTER


Constructor Detail
Top

Token (character, character)
/* Constructor.
Parameters:
pGroup CHARACTER
pArg CHARACTER
Top

Token (character, character, logical)
/* Constructor.
Parameters:
pGroup CHARACTER
pArg CHARACTER
pUnknownValAllowed LOGICAL


Property Detail
Top

LOGICAL AllowUnknownValue
Returns LOGICAL
Top

CHARACTER Arg
Returns CHARACTER
Top

CHARACTER Group
Returns CHARACTER
Top

CHARACTER Value
Returns CHARACTER


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.6.0