Difference between revisions of "Extensions.StringUtil.Decode"
Jump to navigation
Jump to search
m (Hb moved page Decode to Extensions.StringUtil.Decode: #3153) |
|||
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:StringUtil]] | + | {{DISPLAYTITLE:'''Decode '''}}[[Category:StringUtil]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | Decode | Decodes a string | [[Term]] | [[StringUtil|OTX StringUtil extension]] | [[StringUtil related terms]] | [[ | + | {{ClassificationActivity | Decode | Decodes a string | [[Term]] | [[Extensions.StringUtil|OTX StringUtil extension]] | [[Extensions.StringUtil#Terms|StringUtil related terms]] | [[Extensions.StringUtil.UnsupportedEncodingException|UnsupportedEncodingException]] <br/> [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | StringTerm | + | StringTerm StringUtil.Decode(EncodingTerm encoding, ByteFieldTerm byteField); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''Decode''' term | + | The '''Decode''' term will construct a '''String''' by decoding a given '''ByteField''' using a specified encoding. |
| − | {{TermReturnValue| [[String]] | Decoded string according to the given encoding.}} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Decoded string according to the given encoding.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| | + | {{TableRowPropertie1| Encoding | [[Extensions.StringUtil.Encoding|Encoding]] | [[Term]] | @Encoding:US-ASCII | [1] | This element represents the encoding to be used. The set of standard encodings which will be supported by any runtime system is given by the '''Encoding''' enumeration }} |
| − | {{ | + | {{TableRowPropertie2| ByteField | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | Represents the ByteField which will be transformed to a String by using the given encoding.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | String | + | /// Local Declarations |
| − | + | ||
| + | String String1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | String1 = StringUtil.Decode( @Encoding:US-ASCII, &46464646); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[ReplaceSubString]] <br/> | + | [[Extensions.StringUtil.ReplaceSubString|ReplaceSubString]] <br/> |
| − | [[MatchToRegularExpression]] <br/> | + | [[Extensions.StringUtil.MatchToRegularExpression|MatchToRegularExpression]] <br/> |
| − | [[StringConcatenate]] <br/> | + | [[Extensions.StringUtil.StringConcatenate|StringConcatenate]] <br/> |
| − | [[SubString]] <br/> | + | [[Extensions.StringUtil.SubString|SubString]] <br/> |
| − | [[LengthOfString]] <br/> | + | [[Extensions.StringUtil.LengthOfString|LengthOfString]] <br/> |
| − | [[IndexOf]] <br/> | + | [[Extensions.StringUtil.IndexOf|IndexOf]] <br/> |
| − | [[SplitString]] <br/> | + | [[Extensions.StringUtil.SplitString|SplitString]] <br/> |
| − | [[ToUpper]] <br/> | + | [[Extensions.StringUtil.ToUpper|ToUpper]] <br/> |
| − | [[ToLower]] <br/> | + | [[Extensions.StringUtil.ToLower|ToLower]] <br/> |
| − | [[Encode]] | + | [[Extensions.StringUtil.Encode|Encode]] |
Latest revision as of 03:19, 13 September 2019
Contents
Classification
| Name | Decode |
| Short Description | Decodes a string |
| Class | Term |
| Extension | OTX StringUtil extension |
| Group | StringUtil related terms |
| Exceptions | UnsupportedEncodingException OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
StringTerm StringUtil.Decode(EncodingTerm encoding, ByteFieldTerm byteField);Description
The Decode term will construct a String by decoding a given ByteField using a specified encoding.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| String | Decoded string according to the given encoding. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Encoding | Encoding | Term | @Encoding:US-ASCII | [1] | This element represents the encoding to be used. The set of standard encodings which will be supported by any runtime system is given by the Encoding enumeration |
| ByteField | ByteField | Term | - | [1] | Represents the ByteField which will be transformed to a String by using the given encoding. |
OTL Examples
/// Local Declarations
String String1;
/// Flow
String1 = StringUtil.Decode( @Encoding:US-ASCII, &46464646);See also
ReplaceSubString
MatchToRegularExpression
StringConcatenate
SubString
LengthOfString
IndexOf
SplitString
ToUpper
ToLower
Encode
