Class: GroupDocsComparisonCloud::ChangeInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_comparison_cloud/models/change_info.rb

Overview

ChangeInfo Object fields

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChangeInfo

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 114

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.key?(:'ComparisonAction')
    self.comparison_action = attributes[:'ComparisonAction']
  end

  if attributes.key?(:'Type')
    self.type = attributes[:'Type']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end

  if attributes.key?(:'TargetText')
    self.target_text = attributes[:'TargetText']
  end

  if attributes.key?(:'Authors')
    if (value = attributes[:'Authors']).is_a?(Array)
      self.authors = value
    end
  end

  if attributes.key?(:'StyleChangeInfo')
    if (value = attributes[:'StyleChangeInfo']).is_a?(Array)
      self.style_change_info = value
    end
  end

  if attributes.key?(:'PageInfo')
    self.page_info = attributes[:'PageInfo']
  end

  if attributes.key?(:'Box')
    self.box = attributes[:'Box']
  end

end

Instance Attribute Details

#authors ⇒ Object

Array of authors who made this change (used for multi comparison)



50
51
52
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 50

def authors
  @authors
end

#box ⇒ Object

Coordinates of changed element



59
60
61
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 59

def box
  @box
end

#comparison_action ⇒ Object

Action (accept or reject). This field shows comparison what to do with this change



38
39
40
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 38

def comparison_action
  @comparison_action
end

#id ⇒ Object

Id of change



35
36
37
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 35

def id
  @id
end

#page_info ⇒ Object

Page where current change is placed



56
57
58
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 56

def page_info
  @page_info
end

#style_change_info ⇒ Object

Array of style changes



53
54
55
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 53

def style_change_info
  @style_change_info
end

#target_text ⇒ Object

Changed text of target doc



47
48
49
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 47

def target_text
  @target_text
end

#text ⇒ Object

Text of changed element



44
45
46
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 44

def text
  @text
end

#type ⇒ Object

Type of change (Inserted, Deleted or StyleChanged)



41
42
43
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 41

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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

def self.attribute_map
  {
    :'id' => :'Id',
    :'comparison_action' => :'ComparisonAction',
    :'type' => :'Type',
    :'text' => :'Text',
    :'target_text' => :'TargetText',
    :'authors' => :'Authors',
    :'style_change_info' => :'StyleChangeInfo',
    :'page_info' => :'PageInfo',
    :'box' => :'Box'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 98

def self.swagger_types
  {
    :'id' => :'Integer',
    :'comparison_action' => :'String',
    :'type' => :'String',
    :'text' => :'String',
    :'target_text' => :'String',
    :'authors' => :'Array<String>',
    :'style_change_info' => :'Array<StyleChangeInfo>',
    :'page_info' => :'PageInfo',
    :'box' => :'Rectangle'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 231

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      id == other.id &&
      comparison_action == other.comparison_action &&
      type == other.type &&
      text == other.text &&
      target_text == other.target_text &&
      authors == other.authors &&
      style_change_info == other.style_change_info &&
      page_info == other.page_info &&
      box == other.box
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 290

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.parse value
  when :Date
    Date.parse value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else
  # model
    temp_model = GroupDocsComparisonCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 357

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 266

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not                    
      if value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


247
248
249
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 247

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 253

def hash
  [id, comparison_action, type, text, target_text, authors, style_change_info, page_info, box].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 164

def list_invalid_properties
  invalid_properties = []
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @comparison_action.nil?
    invalid_properties.push("invalid value for 'comparison_action', comparison_action cannot be nil.")
  end

  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

  if @box.nil?
    invalid_properties.push("invalid value for 'box', box cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 337

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
346
347
348
349
350
351
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 343

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



331
332
333
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 331

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



259
260
261
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 259

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/groupdocs_comparison_cloud/models/change_info.rb', line 187

def valid?
  return false if @id.nil?
  return false if @comparison_action.nil?
  comparison_action_validator = EnumAttributeValidator.new('String', ["None", "Accept", "Reject"])
  return false unless comparison_action_validator.valid?(@comparison_action)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["None", "Modified", "Inserted", "Deleted", "Added", "NotModified", "StyleChanged", "Resized", "Moved", "MovedAndResized", "ShiftedAndResized"])
  return false unless type_validator.valid?(@type)
  return false if @box.nil?
  return true
end