Difference between revisions of "Extensions.StringUtil.IndexOf"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:'''IndexOf '''}}[[Category:StringUtil]]
 
{{DISPLAYTITLE:'''IndexOf '''}}[[Category:StringUtil]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | IndexOf | Position within a string | [[Term]] | [[Extensions.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]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
IntegerTerm = IndexOf(StringTerm, StringTerm);
+
IntegerTerm = StringUtil.IndexOf(StringTerm, StringTerm);
 
</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 shall 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 shall be -1.
  
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|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 shall be -1.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| String | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The original string}}
+
{{TableRowPropertie1| String | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the input string in which the pattern shall be searched.}}
{{TableRowPropertie2| Pattern | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The substring to search}}
+
{{TableRowPropertie2| Pattern | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Represents the sub-string which shall be searched for in the input string.}}
 
|}
 
|}
  
Line 24: Line 24:
 
Integer Integer1;
 
Integer Integer1;
  
Integer1 = IndexOf("emotive company", "com");
+
/// Flow
 +
 
 +
Integer1 = StringUtil.IndexOf("emotive company", "com");
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 09:35, 3 October 2018

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, StringTerm);

Description

The IndexOf term shall 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 shall 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 shall be -1.

Properties

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

OTL Examples

Integer Integer1;

/// Flow

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

See also

ReplaceSubString
MatchToRegularExpression
StringConcatenate
SubString
LengthOfString
SplitString
ToUpper
ToLower
Encode
Decode