Difference between revisions of "Extensions.StringUtil.Encode"

Revision as of 10:43, 10 February 2015

Name	Encode
Short Description	Encodes a string
Class	Term
Extension	OTX StringUtil extension
Group	StringUtil related terms
Exceptions	UnknownEncodingException OutOfBoundsException
Checker Rules	-
Standard Compliant	Yes

ByteFieldTerm = Encode(StringTerm, EncodingType);

The Encode term encodes the specified string corresponding to the specified encoding and returns a ByteField as a result.

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
ByteField	Encoded string according to the given encoding.

Name	Data Type	Class	Default	Cardinality	Description
String	String	Term	-	[1]	The original string
Encoding	Encoding	Value	@Encoding:US-ASCII	[1]	Encoding is applied to the string

ByteField result;
result = Encode("FFFF", @Encoding:US-ASCII);

@@ Line 3: / Line 3: @@
 {{ClassificationActivity | Encode | Encodes a string | [[Term]] | [[StringUtil|OTX StringUtil extension]] | [[StringUtil related terms]] | [[UnknownEncodingException]] <br/> [[OutOfBoundsException]] | - }}
-== Pseudo-Code Syntax ==
+== OTL Syntax ==
 <syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
-ByteField Encode(String string, Encoding encoding);
+ByteFieldTerm = Encode(StringTerm, EncodingType);
 </syntaxhighlight>
@@ Line 20: / Line 20: @@
 |}
-== Examples ==
+== OTL Examples ==
 <syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
-ByteField result = Encode("FFFF", @Encoding:US-ASCII);
+ByteField result;
-//Returns result = 46464646
+result = Encode("FFFF", @Encoding:US-ASCII);
 </syntaxhighlight>