Class: Angus::SDoc::Definitions::ResponseElement
- Inherits:
-
Object
- Object
- Angus::SDoc::Definitions::ResponseElement
- Defined in:
- lib/angus/definitions/response_element.rb
Instance Attribute Summary collapse
-
#default ⇒ String
The default value of the response element.
-
#description ⇒ String
The description of the response element.
-
#elements_type ⇒ String
The elements type of the response element.
-
#name ⇒ String
The name of the response element.
-
#required ⇒ Boolean
Indicates if the response element is required or not.
-
#type ⇒ String
The type of the response element.
Instance Method Summary collapse
-
#initialize(name = nil, description = nil, required = nil, type = nil, default = nil, elements_type = nil) ⇒ ResponseElement
constructor
A new instance of ResponseElement.
Constructor Details
#initialize(name = nil, description = nil, required = nil, type = nil, default = nil, elements_type = nil) ⇒ ResponseElement
Returns a new instance of ResponseElement.
29 30 31 32 33 34 35 36 37 |
# File 'lib/angus/definitions/response_element.rb', line 29 def initialize(name = nil, description = nil, required = nil, type = nil, default = nil, elements_type = nil) @name = name @description = description @required = required @type = type @default = default @elements_type = elements_type end |
Instance Attribute Details
#default ⇒ String
Returns the default value of the response element.
23 24 25 |
# File 'lib/angus/definitions/response_element.rb', line 23 def default @default end |
#description ⇒ String
Returns the description of the response element.
11 12 13 |
# File 'lib/angus/definitions/response_element.rb', line 11 def description @description end |
#elements_type ⇒ String
Returns the elements type of the response element.
27 28 29 |
# File 'lib/angus/definitions/response_element.rb', line 27 def elements_type @elements_type end |
#name ⇒ String
Returns the name of the response element.
7 8 9 |
# File 'lib/angus/definitions/response_element.rb', line 7 def name @name end |
#required ⇒ Boolean
Returns indicates if the response element is required or not.
15 16 17 |
# File 'lib/angus/definitions/response_element.rb', line 15 def required @required end |
#type ⇒ String
Returns the type of the response element.
19 20 21 |
# File 'lib/angus/definitions/response_element.rb', line 19 def type @type end |