Difference between revisions of "Extensions.StringUtil.IndexOf"

From emotive
Jump to navigation Jump to search
(Created page with "Category:StringUtil == Classification == {{ClassificationActivity | IndexOf | Position within a string | Term | OTX StringUtil extension | StringUtil...")
 
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:StringUtil]]
+
{{DISPLAYTITLE:'''IndexOf '''}}[[Category:StringUtil]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | IndexOf | Position within a string | [[Term]] | [[StringUtil|OTX StringUtil extension]] | [[StringUtil related terms]] | - | - }}
+
{{ClassificationActivity | IndexOf | Position within a string | [[Term]] | [[Extensions.StringUtil|OTX StringUtil extension]] | [[Extensions.StringUtil#Terms|StringUtil related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Integer IndexOf(String string, String pattern);
+
IntegerTerm StringUtil.IndexOf(StringTerm string, StringTerm pattern);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The '''IndexOf''' term returns the zero-based position of the first occurrence of a substring (pattern) in a string , otherwise -1.
+
The '''IndexOf''' term will return the index within a string of the first occurrence of the specified pattern string. If the pattern is not included in the string, the return value will be -1.
  
{{TermReturnValue| [[Integer]] | The first occurrence of a substring (pattern) in a string. If the substring in the string, then -1 is returned}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The index within a string of the first occurrence of the specified pattern string. If the pattern is not included in the string, the return value will be -1.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| String | [[String]] | [[Term]] | - | [1] | The original string}}
+
{{TableRowPropertie1| String | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the input string in which the pattern will be searched.}}
{{TableRowPropertie2| Pattern | [[String]] | [[Term]] | - | [1] | The substring to search}}
+
{{TableRowPropertie2| Pattern | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the sub-string which will be searched for in the input string.}}
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Integer result = IndexOf("emotive", "emo");
+
/// Local Declarations
//Returns result = 0
+
 
 +
Integer Integer1;
 +
 
 +
/// Flow
 +
 
 +
Integer1 = StringUtil.IndexOf("emotive company", "com");
 
</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/>
[[SplitString]] <br/>
+
[[Extensions.StringUtil.SplitString|SplitString]] <br/>
[[ToUpper]] <br/>
+
[[Extensions.StringUtil.ToUpper|ToUpper]] <br/>
[[ToLower]] <br/>
+
[[Extensions.StringUtil.ToLower|ToLower]] <br/>
[[Encode]] <br/>
+
[[Extensions.StringUtil.Encode|Encode]] <br/>
[[Decode]]
+
[[Extensions.StringUtil.Decode|Decode]]

Latest revision as of 03:18, 13 September 2019

Classification

Name IndexOf
Short Description Position within a string
Class Term
Extension OTX StringUtil extension
Group StringUtil related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm StringUtil.IndexOf(StringTerm string, StringTerm pattern);

Description

The IndexOf term will return the index within a string of the first occurrence of the specified pattern string. If the pattern is not included in the string, the return value will be -1.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Integer The index within a string of the first occurrence of the specified pattern string. If the pattern is not included in the string, the return value will be -1.

Properties

Name Data Type Class Default Cardinality Description
String String Term - [1] Represents the input string in which the pattern will be searched.
Pattern String Term - [1] Represents the sub-string which will be searched for in the input string.

OTL Examples

/// Local Declarations

Integer Integer1;

/// Flow

Integer1 = StringUtil.IndexOf("emotive company", "com");

See also

ReplaceSubString
MatchToRegularExpression
StringConcatenate
SubString
LengthOfString
SplitString
ToUpper
ToLower
Encode
Decode