Class: GroupDocsEditorCloud::TextLoadOptions

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

Overview

Allows to specify custom options for loading plain text (TXT) documents

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
106
107
108
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
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 104

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

  if attributes.key?(:'LeadingSpaces')
    self.leading_spaces = attributes[:'LeadingSpaces']
  end

  if attributes.key?(:'TrailingSpaces')
    self.trailing_spaces = attributes[:'TrailingSpaces']
  end

  if attributes.key?(:'EnablePagination')
    self.enable_pagination = attributes[:'EnablePagination']
  end

end

Instance Attribute Details

#enable_pagination ⇒ Object

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).



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

def enable_pagination
  @enable_pagination
end

#encoding ⇒ Object

Character encoding of the text document, which will be applied for its opening



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

def encoding
  @encoding
end

#file_info ⇒ Object

File info



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

def file_info
  @file_info
end

#leading_spaces ⇒ Object

Gets or sets preferred option of a leading space handling. By default converts leading spaces to the left indent.



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

def leading_spaces
  @leading_spaces
end

#output_path ⇒ Object

The full output path



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

def output_path
  @output_path
end

#recognize_lists ⇒ Object

Allows to specify how numbered list items are recognized when document is imported from plain text format. The default value is true.



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

def recognize_lists
  @recognize_lists
end

#trailing_spaces ⇒ Object

Gets or sets preferred option of a trailing space handling. By default truncates all trailing spaces.



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

def trailing_spaces
  @trailing_spaces
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 77

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'OutputPath',
    :'encoding' => :'Encoding',
    :'recognize_lists' => :'RecognizeLists',
    :'leading_spaces' => :'LeadingSpaces',
    :'trailing_spaces' => :'TrailingSpaces',
    :'enable_pagination' => :'EnablePagination'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 90

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'String',
    :'encoding' => :'String',
    :'recognize_lists' => :'BOOLEAN',
    :'leading_spaces' => :'String',
    :'trailing_spaces' => :'String',
    :'enable_pagination' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      recognize_lists == other.recognize_lists &&
      leading_spaces == other.leading_spaces &&
      trailing_spaces == other.trailing_spaces &&
      enable_pagination == other.enable_pagination
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



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
301
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 264

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



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

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



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

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


221
222
223
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 221

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 227

def hash
  [file_info, output_path, encoding, recognize_lists, leading_spaces, trailing_spaces, enable_pagination].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 142

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

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

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

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



311
312
313
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 311

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



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

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



305
306
307
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 305

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



233
234
235
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 233

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



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/groupdocs_editor_cloud/models/text_load_options.rb', line 165

def valid?
  return false if @recognize_lists.nil?
  return false if @leading_spaces.nil?
  leading_spaces_validator = EnumAttributeValidator.new('String', ["ConvertToIndent", "Preserve", "Trim"])
  return false unless leading_spaces_validator.valid?(@leading_spaces)
  return false if @trailing_spaces.nil?
  trailing_spaces_validator = EnumAttributeValidator.new('String', ["Trim", "Preserve"])
  return false unless trailing_spaces_validator.valid?(@trailing_spaces)
  return false if @enable_pagination.nil?
  return true
end