Class: Yoda::Evaluation::CommentCompletion::BaseProvider Abstract
- Inherits:
-
Object
- Object
- Yoda::Evaluation::CommentCompletion::BaseProvider
- Defined in:
- lib/yoda/evaluation/comment_completion/base_provider.rb
Overview
This class is abstract.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#ast ⇒ Object
readonly
Returns the value of attribute ast.
-
#comments ⇒ Object
readonly
Returns the value of attribute comments.
-
#location ⇒ Object
readonly
Returns the value of attribute location.
-
#registry ⇒ Object
readonly
Returns the value of attribute registry.
Instance Method Summary collapse
- #available? ⇒ true, false abstract
- #candidates ⇒ Array<Model::CompletionItem> abstract
-
#initialize(registry, ast, comments, location) ⇒ BaseProvider
constructor
A new instance of BaseProvider.
Constructor Details
#initialize(registry, ast, comments, location) ⇒ BaseProvider
Returns a new instance of BaseProvider.
22 23 24 25 26 27 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 22 def initialize(registry, ast, comments, location) @registry = registry @ast = ast @comments = comments @location = location end |
Instance Attribute Details
#ast ⇒ Object (readonly)
Returns the value of attribute ast.
10 11 12 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 10 def ast @ast end |
#comments ⇒ Object (readonly)
Returns the value of attribute comments.
13 14 15 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 13 def comments @comments end |
#location ⇒ Object (readonly)
Returns the value of attribute location.
16 17 18 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 16 def location @location end |
#registry ⇒ Object (readonly)
Returns the value of attribute registry.
7 8 9 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 7 def registry @registry end |
Instance Method Details
#available? ⇒ true, false
This method is abstract.
31 32 33 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 31 def available? fail NotImplementedError end |
#candidates ⇒ Array<Model::CompletionItem>
This method is abstract.
37 38 39 |
# File 'lib/yoda/evaluation/comment_completion/base_provider.rb', line 37 def candidates fail NotImplementedError end |