Class: GroupDocsEditorCloud::XmlLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_editor_cloud/models/xml_load_options.rb

Overview

Allows to specify custom options for loading XML (eXtensible Markup Language) documents

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ XmlLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
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
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 109

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

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

  if attributes.key?(:'Encoding')
    self.encoding = attributes[:'Encoding']
  end

  if attributes.key?(:'FixIncorrectStructure')
    self.fix_incorrect_structure = attributes[:'FixIncorrectStructure']
  end

  if attributes.key?(:'RecognizeUris')
    self.recognize_uris = attributes[:'RecognizeUris']
  end

  if attributes.key?(:'RecognizeEmails')
    self.recognize_emails = attributes[:'RecognizeEmails']
  end

  if attributes.key?(:'TrimTrailingWhitespaces')
    self.trim_trailing_whitespaces = attributes[:'TrimTrailingWhitespaces']
  end

  if attributes.key?(:'AttributeValuesQuoteType')
    self.attribute_values_quote_type = attributes[:'AttributeValuesQuoteType']
  end

end

Instance Attribute Details

#attribute_values_quote_type ⇒ Object

Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default.



56
57
58
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 56

def attribute_values_quote_type
  @attribute_values_quote_type
end

#encoding ⇒ Object

Character encoding of the text document, which will be applied for its opening. By default is null - internal document encoding will be applied.



41
42
43
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 41

def encoding
  @encoding
end

#file_info ⇒ Object

File info



35
36
37
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 35

def file_info
  @file_info
end

#fix_incorrect_structure ⇒ Object

Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false).



44
45
46
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 44

def fix_incorrect_structure
  @fix_incorrect_structure
end

#output_path ⇒ Object

The full output path



38
39
40
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 38

def output_path
  @output_path
end

#recognize_emails ⇒ Object

Allows to enable recognition algorithm for email addresses in attribute values



50
51
52
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 50

def recognize_emails
  @recognize_emails
end

#recognize_uris ⇒ Object

Allows to enable URI recognition algorithm



47
48
49
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 47

def recognize_uris
  @recognize_uris
end

#trim_trailing_whitespaces ⇒ Object

Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) - trailing whitespaces will be preserved.



53
54
55
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 53

def trim_trailing_whitespaces
  @trim_trailing_whitespaces
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 80

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'OutputPath',
    :'encoding' => :'Encoding',
    :'fix_incorrect_structure' => :'FixIncorrectStructure',
    :'recognize_uris' => :'RecognizeUris',
    :'recognize_emails' => :'RecognizeEmails',
    :'trim_trailing_whitespaces' => :'TrimTrailingWhitespaces',
    :'attribute_values_quote_type' => :'AttributeValuesQuoteType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 94

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'String',
    :'encoding' => :'String',
    :'fix_incorrect_structure' => :'BOOLEAN',
    :'recognize_uris' => :'BOOLEAN',
    :'recognize_emails' => :'BOOLEAN',
    :'trim_trailing_whitespaces' => :'BOOLEAN',
    :'attribute_values_quote_type' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 205

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      output_path == other.output_path &&
      encoding == other.encoding &&
      fix_incorrect_structure == other.fix_incorrect_structure &&
      recognize_uris == other.recognize_uris &&
      recognize_emails == other.recognize_emails &&
      trim_trailing_whitespaces == other.trim_trailing_whitespaces &&
      attribute_values_quote_type == other.attribute_values_quote_type
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 263

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 = GroupDocsEditorCloud.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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 330

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 239

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


220
221
222
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 220

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 226

def hash
  [file_info, output_path, encoding, fix_incorrect_structure, recognize_uris, recognize_emails, trim_trailing_whitespaces, attribute_values_quote_type].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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 151

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

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

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

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

  if @attribute_values_quote_type.nil?
    invalid_properties.push("invalid value for 'attribute_values_quote_type', attribute_values_quote_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



310
311
312
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 310

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 316

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



304
305
306
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 304

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



232
233
234
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 232

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



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/groupdocs_editor_cloud/models/xml_load_options.rb', line 178

def valid?
  return false if @fix_incorrect_structure.nil?
  return false if @recognize_uris.nil?
  return false if @recognize_emails.nil?
  return false if @trim_trailing_whitespaces.nil?
  return false if @attribute_values_quote_type.nil?
  attribute_values_quote_type_validator = EnumAttributeValidator.new('String', ["DoubleQuote", "SingleQuote"])
  return false unless attribute_values_quote_type_validator.valid?(@attribute_values_quote_type)
  return true
end