Pattern to attach matching to start of line

Contract
Parameter key	Default value	Type
a_type	opt
regex_string	"^"	string

Water Contract
<class pattern.start_of_line regex_string ="^"=string _native_object=<ja.org.apache.regexp.RE/> />

See also: is_type_for, get_string_segments, replace_string_segments, string_segment

Returns a pattern with a regex_string field set to " ^ ". This pattern is useful for forcing the match to check against the start of the target string.

Example: Match string of punctuation at start only

<pattern pattern.start_of_line
         pattern.<one_or_more pattern.punctuation /> />.
<is_type_for "!@#abcdefg087" />

true

Example: Does not match punctuation at start

<pattern pattern.start_of_line
         pattern.<one_or_more pattern.punctuation /> />.
<is_type_for "x!@#abcdefg087" />

false