Class: ActionWebService::BaseType

Inherits:
Object
  • Object
show all
Includes:
SignatureTypes
Defined in:
lib/action_web_service/support/signature_types.rb

Overview

:nodoc:

Direct Known Subclasses

ArrayType, StructuredType

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from SignatureTypes

#canonical_signature, #canonical_signature_entry, #canonical_type, #canonical_type_class, #canonical_type_name, #class_to_type_name, #derived_from?, #symbol_name, #type_name_to_class

Constructor Details

- (BaseType) initialize(spec, type, name)

A new instance of BaseType



158
159
160
161
162
163
# File 'lib/action_web_service/support/signature_types.rb', line 158

def initialize(spec, type, name)
  @spec = spec
  @type = canonical_type(type)
  @type_class = canonical_type_class(@type)
  @name = name
end

Instance Attribute Details

- (Object) name (readonly)

Returns the value of attribute name



156
157
158
# File 'lib/action_web_service/support/signature_types.rb', line 156

def name
  @name
end

- (Object) spec (readonly)

Returns the value of attribute spec



153
154
155
# File 'lib/action_web_service/support/signature_types.rb', line 153

def spec
  @spec
end

- (Object) type (readonly)

Returns the value of attribute type



154
155
156
# File 'lib/action_web_service/support/signature_types.rb', line 154

def type
  @type
end

- (Object) type_class (readonly)

Returns the value of attribute type_class



155
156
157
# File 'lib/action_web_service/support/signature_types.rb', line 155

def type_class
  @type_class
end

Instance Method Details

- (Boolean) array?

Returns:

  • (Boolean)


169
170
171
# File 'lib/action_web_service/support/signature_types.rb', line 169

def array?
  false
end

- (Boolean) custom?

Returns:

  • (Boolean)


165
166
167
# File 'lib/action_web_service/support/signature_types.rb', line 165

def custom?
  false
end

- (Object) human_name(show_name = true)



177
178
179
180
181
# File 'lib/action_web_service/support/signature_types.rb', line 177

def human_name(show_name=true)
  type_type = array? ? element_type.type.to_s : self.type.to_s
  str = array? ? (type_type + '[]') : type_type
  show_name ? (str + " " + name.to_s) : str
end

- (Boolean) structured?

Returns:

  • (Boolean)


173
174
175
# File 'lib/action_web_service/support/signature_types.rb', line 173

def structured?
  false
end