Class: Comet::SingleFieldSource

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/single_field_source.rb

Overview

SingleFieldSource is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SingleFieldSource

Returns a new instance of SingleFieldSource.



34
35
36
 
# File 'lib/comet/models/single_field_source.rb', line 34

def initialize
  clear
end

Instance Attribute Details

#bool_val ⇒ Object

Returns the value of attribute bool_val.



23
24
25
 
# File 'lib/comet/models/single_field_source.rb', line 23

def bool_val
  @bool_val
end

#field_name ⇒ Object

Returns the value of attribute field_name.



16
17
18
 
# File 'lib/comet/models/single_field_source.rb', line 16

def field_name
  @field_name
end

#field_type ⇒ Object

One of “bool” / “int” / “string”



20
21
22
 
# File 'lib/comet/models/single_field_source.rb', line 20

def field_type
  @field_type
end

#int_val ⇒ Object

Returns the value of attribute int_val.



26
27
28
 
# File 'lib/comet/models/single_field_source.rb', line 26

def int_val
  @int_val
end

#str_val ⇒ Object

Returns the value of attribute str_val.



29
30
31
 
# File 'lib/comet/models/single_field_source.rb', line 29

def str_val
  @str_val
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



32
33
34
 
# File 'lib/comet/models/single_field_source.rb', line 32

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/comet/models/single_field_source.rb', line 38

def clear
  @field_name = ''
  @field_type = ''
  @int_val = 0
  @str_val = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/comet/models/single_field_source.rb', line 54

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'FieldName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @field_name = v
    when 'FieldType'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @field_type = v
    when 'BoolVal'
      @bool_val = v
    when 'IntVal'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @int_val = v
    when 'StrVal'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @str_val = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


47
48
49
50
51
 
# File 'lib/comet/models/single_field_source.rb', line 47

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



98
99
100
 
# File 'lib/comet/models/single_field_source.rb', line 98

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/comet/models/single_field_source.rb', line 84

def to_hash
  ret = {}
  ret['FieldName'] = @field_name
  ret['FieldType'] = @field_type
  ret['BoolVal'] = @bool_val
  ret['IntVal'] = @int_val
  ret['StrVal'] = @str_val
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



103
104
105
 
# File 'lib/comet/models/single_field_source.rb', line 103

def to_json(options = {})
  to_hash.to_json(options)
end