Class: GroupDocsComparisonCloud::ComparisonOptions

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

Overview

Defines comparison options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComparisonOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 94

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?(:'SourceFile')
    self.source_file = attributes[:'SourceFile']
  end

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

  if attributes.key?(:'Settings')
    self.settings = attributes[:'Settings']
  end

  if attributes.key?(:'ChangeType')
    self.change_type = attributes[:'ChangeType']
  end

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

end

Instance Attribute Details

#change_type ⇒ Object

Changes type. Used only for Changes resource(/comparison/changes)



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

def change_type
  @change_type
end

#output_path ⇒ Object

Path to the resultant document (if not specified the document will not be saved)



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

def output_path
  @output_path
end

#settings ⇒ Object

Comparison settings



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

def settings
  @settings
end

#source_file ⇒ Object

Information about source file



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

def source_file
  @source_file
end

#target_files ⇒ Object

Information about target file(s)



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

def target_files
  @target_files
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 71

def self.attribute_map
  {
    :'source_file' => :'SourceFile',
    :'target_files' => :'TargetFiles',
    :'settings' => :'Settings',
    :'change_type' => :'ChangeType',
    :'output_path' => :'OutputPath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 82

def self.swagger_types
  {
    :'source_file' => :'FileInfo',
    :'target_files' => :'Array<FileInfo>',
    :'settings' => :'Settings',
    :'change_type' => :'String',
    :'output_path' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 161

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      source_file == other.source_file &&
      target_files == other.target_files &&
      settings == other.settings &&
      change_type == other.change_type &&
      output_path == other.output_path
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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 216

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 283

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 192

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


173
174
175
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 179

def hash
  [source_file, target_files, settings, change_type, output_path].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



126
127
128
129
130
131
132
133
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 126

def list_invalid_properties
  invalid_properties = []
  if @change_type.nil?
    invalid_properties.push("invalid value for 'change_type', change_type 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



263
264
265
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 269

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



257
258
259
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 257

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



185
186
187
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 185

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



137
138
139
140
141
142
 
# File 'lib/groupdocs_comparison_cloud/models/comparison_options.rb', line 137

def valid?
  return false if @change_type.nil?
  change_type_validator = EnumAttributeValidator.new('String', ["None", "Modified", "Inserted", "Deleted", "Added", "NotModified", "StyleChanged", "Resized", "Moved", "MovedAndResized", "ShiftedAndResized"])
  return false unless change_type_validator.valid?(@change_type)
  return true
end