api/cucumber/ruby/yardoc/Cucumber/Ast/Step.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Class: Cucumber::Ast::Step
  
    &mdash; Documentation by YARD 0.8.5.2
  
</title>

  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '../../';
  framesUrl = "../../frames.html#!" + escape(window.location.href);
</script>


  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


  </head>
  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>
    
    <div id="header">
      <h3><img src="../../images/bubble_32x32.png"></img> Cucumber 1.2.5</h3>
      <div id="menu">
  
    <a href="../../_index.html">Index (S)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../../Cucumber.html" title="Cucumber (module)">Cucumber</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Ast.html" title="Cucumber::Ast (module)">Ast</a></span></span>
     &raquo; 
    <span class="title">Step</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../../class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="../../method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="../../file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>
    
    <iframe id="search_frame"></iframe>
    
    <div id="content"><h1>Class: Cucumber::Ast::Step
  
  
</h1>

<dl class="box">
  
    <dt class="r1">Inherits:</dt>
    <dd class="r1">
      <span class="inheritName"><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></span>
      
        <ul class="fullTree">
          <li><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></li>
          
            <li class="next">Cucumber::Ast::Step</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
      </dd>
    
  
    <dt class="r2 last">Defined in:</dt>
    <dd class="r2 last">lib/cucumber/ast/step.rb</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
<p>:nodoc:</p>


  </div>
</div>
<div class="tags">
  

</div>
  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="INDENT-constant" class="">INDENT =
          
        </dt>
        <dd><pre class="code"><span class='int'>2</span></pre></dd>
      
    </dl>
  

  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#exception-instance_method" title="#exception (instance method)">- (Object) <strong>exception</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute exception.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#feature_element-instance_method" title="#feature_element (instance method)">- (Object) <strong>feature_element</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute feature_element.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#gherkin_statement-instance_method" title="#gherkin_statement (instance method)">- (Object) <strong>gherkin_statement</strong>(statement = nil) </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute gherkin_statement.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#keyword-instance_method" title="#keyword (instance method)">- (Object) <strong>keyword</strong> </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute keyword.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#line-instance_method" title="#line (instance method)">- (Object) <strong>line</strong> </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute line.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#multiline_arg-instance_method" title="#multiline_arg (instance method)">- (Object) <strong>multiline_arg</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute multiline_arg.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute name.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#options%3D-instance_method" title="#options= (instance method)">- (Object) <strong>options</strong> </a>
    

  </span>
  
  
      <span class="note title writeonly">writeonly</span>
    
  
    <span class="summary_desc"><div class='inline'>
<p>Sets the attribute options.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#step_collection%3D-instance_method" title="#step_collection= (instance method)">- (Object) <strong>step_collection</strong> </a>
    

  </span>
  
  
      <span class="note title writeonly">writeonly</span>
    
  
    <span class="summary_desc"><div class='inline'>
<p>Sets the attribute step_collection.</p>
</div></span>
  
</li>

    
  </ul>


    <h2>
      Instance Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#accept-instance_method" title="#accept (instance method)">- (Object) <strong>accept</strong>(visitor) </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#background%3F-instance_method" title="#background? (instance method)">- (Boolean) <strong>background?</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#backtrace_line-instance_method" title="#backtrace_line (instance method)">- (Object) <strong>backtrace_line</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#dom_id-instance_method" title="#dom_id (instance method)">- (Object) <strong>dom_id</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#file_colon_line-instance_method" title="#file_colon_line (instance method)">- (Object) <strong>file_colon_line</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#first_match-instance_method" title="#first_match (instance method)">- (Object) <strong>first_match</strong>(visitor) </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Step) <strong>initialize</strong>(line, keyword, name, multiline_arg = nil) </a>
    

  </span>
  
  
    <span class="note title constructor">constructor</span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>A new instance of Step.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#language-instance_method" title="#language (instance method)">- (Object) <strong>language</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#source_indent-instance_method" title="#source_indent (instance method)">- (Object) <strong>source_indent</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#status-instance_method" title="#status (instance method)">- (Object) <strong>status</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#step_invocation-instance_method" title="#step_invocation (instance method)">- (Object) <strong>step_invocation</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#step_invocation_from_cells-instance_method" title="#step_invocation_from_cells (instance method)">- (Object) <strong>step_invocation_from_cells</strong>(cells) </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#text_length-instance_method" title="#text_length (instance method)">- (Object) <strong>text_length</strong>(name = @name) </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#to_sexp-instance_method" title="#to_sexp (instance method)">- (Object) <strong>to_sexp</strong> </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#visit_step_result-instance_method" title="#visit_step_result (instance method)">- (Object) <strong>visit_step_result</strong>(visitor, step_match, multiline_arg, status, exception, background) </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
    </ul>
  

<div id="constructor_details" class="method_details_list">
  <h2>Constructor Details</h2>
  
    <div class="method_details first">
  <h3 class="signature first" id="initialize-instance_method">
  
    - (<tt><span class='object_link'><a href="" title="Cucumber::Ast::Step (class)">Step</a></span></tt>) <strong>initialize</strong>(line, keyword, name, multiline_arg = nil) 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>A new instance of Step</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


13
14
15</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 13</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='comma'>,</span> <span class='id identifier rubyid_keyword'>keyword</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_multiline_arg'>multiline_arg</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
  <span class='ivar'>@line</span><span class='comma'>,</span> <span class='ivar'>@keyword</span><span class='comma'>,</span> <span class='ivar'>@name</span><span class='comma'>,</span> <span class='ivar'>@multiline_arg</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span><span class='comma'>,</span> <span class='id identifier rubyid_keyword'>keyword</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_multiline_arg'>multiline_arg</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
  
</div>

  <div id="instance_attr_details" class="attr_details">
    <h2>Instance Attribute Details</h2>
    
      
      <span id="exception=-instance_method"></span>
      <div class="method_details first">
  <h3 class="signature first" id="exception-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>exception</strong> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute exception</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


9
10
11</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 9</span>

<span class='kw'>def</span> <span class='id identifier rubyid_exception'>exception</span>
  <span class='ivar'>@exception</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id="feature_element=-instance_method"></span>
      <div class="method_details ">
  <h3 class="signature " id="feature_element-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>feature_element</strong> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute feature_element</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


9
10
11</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 9</span>

<span class='kw'>def</span> <span class='id identifier rubyid_feature_element'>feature_element</span>
  <span class='ivar'>@feature_element</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="gherkin_statement-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>gherkin_statement</strong>(statement = nil)  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute gherkin_statement</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


17
18
19</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 17</span>

<span class='kw'>def</span> <span class='id identifier rubyid_gherkin_statement'>gherkin_statement</span>
  <span class='ivar'>@gherkin_statement</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="keyword-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>keyword</strong>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute keyword</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


7
8
9</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 7</span>

<span class='kw'>def</span> <span class='id identifier rubyid_keyword'>keyword</span>
  <span class='ivar'>@keyword</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="line-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>line</strong>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute line</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


7
8
9</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 7</span>

<span class='kw'>def</span> <span class='id identifier rubyid_line'>line</span>
  <span class='ivar'>@line</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id="multiline_arg=-instance_method"></span>
      <div class="method_details ">
  <h3 class="signature " id="multiline_arg-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>multiline_arg</strong> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute multiline_arg</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


9
10
11</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 9</span>

<span class='kw'>def</span> <span class='id identifier rubyid_multiline_arg'>multiline_arg</span>
  <span class='ivar'>@multiline_arg</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="name-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>name</strong>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns the value of attribute name</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


7
8
9</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 7</span>

<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
  <span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="options=-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>options=</strong>(value)  <span class="extras">(writeonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Sets the attribute options</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>value</span>
      
      
        <span class='type'></span>
      
      
        &mdash;
        <div class='inline'>
<p>the value to set the attribute options to.</p>
</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


8
9
10</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 8</span>

<span class='kw'>def</span> <span class='id identifier rubyid_options='>options=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
  <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="step_collection=-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>step_collection=</strong>(value)  <span class="extras">(writeonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Sets the attribute step_collection</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>value</span>
      
      
        <span class='type'></span>
      
      
        &mdash;
        <div class='inline'>
<p>the value to set the attribute step_collection to.</p>
</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


8
9
10</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 8</span>

<span class='kw'>def</span> <span class='id identifier rubyid_step_collection='>step_collection=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
  <span class='ivar'>@step_collection</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>


  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="accept-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>accept</strong>(visitor) 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


45
46
47
48
49
50</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 45</span>

<span class='kw'>def</span> <span class='id identifier rubyid_accept'>accept</span><span class='lparen'>(</span><span class='id identifier rubyid_visitor'>visitor</span><span class='rparen'>)</span>
  <span class='kw'>return</span> <span class='kw'>if</span> <span class='const'>Cucumber</span><span class='period'>.</span><span class='id identifier rubyid_wants_to_quit'>wants_to_quit</span>
  <span class='comment'># The only time a Step is visited is when it is in a ScenarioOutline.
</span>  <span class='comment'># Otherwise it&#39;s always StepInvocation that gets visited instead.
</span>  <span class='id identifier rubyid_visit_step_result'>visit_step_result</span><span class='lparen'>(</span><span class='id identifier rubyid_visitor'>visitor</span><span class='comma'>,</span> <span class='id identifier rubyid_first_match'>first_match</span><span class='lparen'>(</span><span class='id identifier rubyid_visitor'>visitor</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='ivar'>@multiline_arg</span><span class='comma'>,</span> <span class='symbol'>:skipped</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="background?-instance_method">
  
    - (<tt>Boolean</tt>) <strong>background?</strong> 
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


22
23
24</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 22</span>

<span class='kw'>def</span> <span class='id identifier rubyid_background?'>background?</span>
  <span class='kw'>false</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="backtrace_line-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>backtrace_line</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


80
81
82</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 80</span>

<span class='kw'>def</span> <span class='id identifier rubyid_backtrace_line'>backtrace_line</span>
  <span class='ivar'>@backtrace_line</span> <span class='op'>||=</span> <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_backtrace_line'>backtrace_line</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@keyword</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='ivar'>@line</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="dom_id-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>dom_id</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


92
93
94</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 92</span>

<span class='kw'>def</span> <span class='id identifier rubyid_dom_id'>dom_id</span>
  <span class='ivar'>@dom_id</span> <span class='op'>||=</span> <span class='id identifier rubyid_file_colon_line'>file_colon_line</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\/</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>:</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="file_colon_line-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>file_colon_line</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


84
85
86</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 84</span>

<span class='kw'>def</span> <span class='id identifier rubyid_file_colon_line'>file_colon_line</span>
  <span class='ivar'>@file_colon_line</span> <span class='op'>||=</span> <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_file_colon_line'>file_colon_line</span><span class='lparen'>(</span><span class='ivar'>@line</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="first_match-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>first_match</strong>(visitor) 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


56
57
58
59
60
61
62
63
64
65
66</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 56</span>

<span class='kw'>def</span> <span class='id identifier rubyid_first_match'>first_match</span><span class='lparen'>(</span><span class='id identifier rubyid_visitor'>visitor</span><span class='rparen'>)</span>
  <span class='comment'># @feature_element is always a ScenarioOutline in this case
</span>  <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_each_example_row'>each_example_row</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cells'>cells</span><span class='op'>|</span>
    <span class='id identifier rubyid_argument_hash'>argument_hash</span>       <span class='op'>=</span> <span class='id identifier rubyid_cells'>cells</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
    <span class='id identifier rubyid_delimited_arguments'>delimited_arguments</span> <span class='op'>=</span> <span class='id identifier rubyid_delimit_argument_names'>delimit_argument_names</span><span class='lparen'>(</span><span class='id identifier rubyid_argument_hash'>argument_hash</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_name'>name</span>                <span class='op'>=</span> <span class='id identifier rubyid_replace_name_arguments'>replace_name_arguments</span><span class='lparen'>(</span><span class='id identifier rubyid_delimited_arguments'>delimited_arguments</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_step_match'>step_match</span>          <span class='op'>=</span> <span class='id identifier rubyid_visitor'>visitor</span><span class='period'>.</span><span class='id identifier rubyid_runtime'>runtime</span><span class='period'>.</span><span class='id identifier rubyid_step_match'>step_match</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='ivar'>@name</span><span class='rparen'>)</span> <span class='kw'>rescue</span> <span class='kw'>nil</span>
    <span class='kw'>return</span> <span class='id identifier rubyid_step_match'>step_match</span> <span class='kw'>if</span> <span class='id identifier rubyid_step_match'>step_match</span>
  <span class='kw'>end</span>
  <span class='const'>NoStepMatch</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='ivar'>@name</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="language-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>language</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


88
89
90</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 88</span>

<span class='kw'>def</span> <span class='id identifier rubyid_language'>language</span>
  <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_language'>language</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="source_indent-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>source_indent</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


72
73
74</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 72</span>

<span class='kw'>def</span> <span class='id identifier rubyid_source_indent'>source_indent</span>
  <span class='ivar'>@feature_element</span><span class='period'>.</span><span class='id identifier rubyid_source_indent'>source_indent</span><span class='lparen'>(</span><span class='id identifier rubyid_text_length'>text_length</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="status-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>status</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


26
27
28
29</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 26</span>

<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
  <span class='comment'># Step always has status skipped, because Step is always in a ScenarioOutline
</span>  <span class='symbol'>:skipped</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="step_invocation-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>step_invocation</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


31
32
33</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 31</span>

<span class='kw'>def</span> <span class='id identifier rubyid_step_invocation'>step_invocation</span>
  <span class='const'>StepInvocation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='ivar'>@name</span><span class='comma'>,</span> <span class='ivar'>@multiline_arg</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="step_invocation_from_cells-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>step_invocation_from_cells</strong>(cells) 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


35
36
37
38
39
40
41
42
43</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 35</span>

<span class='kw'>def</span> <span class='id identifier rubyid_step_invocation_from_cells'>step_invocation_from_cells</span><span class='lparen'>(</span><span class='id identifier rubyid_cells'>cells</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_matched_cells'>matched_cells</span> <span class='op'>=</span> <span class='id identifier rubyid_matched_cells'>matched_cells</span><span class='lparen'>(</span><span class='id identifier rubyid_cells'>cells</span><span class='rparen'>)</span>

  <span class='id identifier rubyid_delimited_arguments'>delimited_arguments</span> <span class='op'>=</span> <span class='id identifier rubyid_delimit_argument_names'>delimit_argument_names</span><span class='lparen'>(</span><span class='id identifier rubyid_cells'>cells</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_name'>name</span>                <span class='op'>=</span> <span class='id identifier rubyid_replace_name_arguments'>replace_name_arguments</span><span class='lparen'>(</span><span class='id identifier rubyid_delimited_arguments'>delimited_arguments</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_multiline_arg'>multiline_arg</span>       <span class='op'>=</span> <span class='ivar'>@multiline_arg</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='ivar'>@multiline_arg</span><span class='period'>.</span><span class='id identifier rubyid_arguments_replaced'>arguments_replaced</span><span class='lparen'>(</span><span class='id identifier rubyid_delimited_arguments'>delimited_arguments</span><span class='rparen'>)</span>

  <span class='const'>StepInvocation</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_multiline_arg'>multiline_arg</span><span class='comma'>,</span> <span class='id identifier rubyid_matched_cells'>matched_cells</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="text_length-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>text_length</strong>(name = @name) 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


76
77
78</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 76</span>

<span class='kw'>def</span> <span class='id identifier rubyid_text_length'>text_length</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='op'>=</span><span class='ivar'>@name</span><span class='rparen'>)</span>
  <span class='const'>INDENT</span> <span class='op'>+</span> <span class='const'>INDENT</span> <span class='op'>+</span> <span class='ivar'>@keyword</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>U*</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>+</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>U*</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="to_sexp-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>to_sexp</strong> 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


68
69
70</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 68</span>

<span class='kw'>def</span> <span class='id identifier rubyid_to_sexp'>to_sexp</span>
  <span class='lbracket'>[</span><span class='symbol'>:step</span><span class='comma'>,</span> <span class='ivar'>@line</span><span class='comma'>,</span> <span class='ivar'>@keyword</span><span class='comma'>,</span> <span class='ivar'>@name</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='ivar'>@multiline_arg</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='ivar'>@multiline_arg</span><span class='period'>.</span><span class='id identifier rubyid_to_sexp'>to_sexp</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="visit_step_result-instance_method">
  
    - (<tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>) <strong>visit_step_result</strong>(visitor, step_match, multiline_arg, status, exception, background) 
  

</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


52
53
54</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/cucumber/ast/step.rb', line 52</span>

<span class='kw'>def</span> <span class='id identifier rubyid_visit_step_result'>visit_step_result</span><span class='lparen'>(</span><span class='id identifier rubyid_visitor'>visitor</span><span class='comma'>,</span> <span class='id identifier rubyid_step_match'>step_match</span><span class='comma'>,</span> <span class='id identifier rubyid_multiline_arg'>multiline_arg</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_exception'>exception</span><span class='comma'>,</span> <span class='id identifier rubyid_background'>background</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_visitor'>visitor</span><span class='period'>.</span><span class='id identifier rubyid_visit_step_result'>visit_step_result</span><span class='lparen'>(</span><span class='ivar'>@keyword</span><span class='comma'>,</span> <span class='id identifier rubyid_step_match'>step_match</span><span class='comma'>,</span> <span class='ivar'>@multiline_arg</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_exception'>exception</span><span class='comma'>,</span> <span class='id identifier rubyid_source_indent'>source_indent</span><span class='comma'>,</span> <span class='id identifier rubyid_background'>background</span><span class='comma'>,</span> <span class='id identifier rubyid_file_colon_line'>file_colon_line</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>
    
    <div id="footer">
  Generated on Mon Apr  8 21:00:59 2013 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.5.2 (ruby-2.0.0).
</div>

  </body>
</html>