Class: GroupDocsAnnotationCloud::DocumentInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_annotation_cloud/models/document_info.rb

Overview

Describes document basic info

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 83

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

  if attributes.key?(:'Path')
    self.path = attributes[:'Path']
  end

  if attributes.key?(:'Extension')
    self.extension = attributes[:'Extension']
  end

  if attributes.key?(:'FileFormat')
    self.file_format = attributes[:'FileFormat']
  end

  if attributes.key?(:'Size')
    self.size = attributes[:'Size']
  end

  if attributes.key?(:'DateModified')
    self.date_modified = attributes[:'DateModified']
  end

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

end

Instance Attribute Details

#date_modified ⇒ Object

Gets or sets the document date modified



50
51
52
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 50

def date_modified
  @date_modified
end

#extension ⇒ Object

Gets or sets the document extension



41
42
43
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 41

def extension
  @extension
end

#file_format ⇒ Object

Gets or sets the file format



44
45
46
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 44

def file_format
  @file_format
end

#name ⇒ Object

Gets or sets the document name



35
36
37
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 35

def name
  @name
end

#pages ⇒ Object

Gets or sets the pages



53
54
55
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 53

def pages
  @pages
end

#path ⇒ Object

Gets or sets the document path



38
39
40
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 38

def path
  @path
end

#size ⇒ Object

Gets or sets the document size



47
48
49
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 47

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 56

def self.attribute_map
  {
    :'name' => :'Name',
    :'path' => :'Path',
    :'extension' => :'Extension',
    :'file_format' => :'FileFormat',
    :'size' => :'Size',
    :'date_modified' => :'DateModified',
    :'pages' => :'Pages'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 69

def self.swagger_types
  {
    :'name' => :'String',
    :'path' => :'String',
    :'extension' => :'String',
    :'file_format' => :'String',
    :'size' => :'Integer',
    :'date_modified' => :'DateTime',
    :'pages' => :'Array<PageInfo>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 146

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      name == other.name &&
      path == other.path &&
      extension == other.extension &&
      file_format == other.file_format &&
      size == other.size &&
      date_modified == other.date_modified &&
      pages == other.pages
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



203
204
205
206
207
208
209
210
211
212
213
214
215
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
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 203

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 270

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 179

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


160
161
162
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 166

def hash
  [name, path, extension, file_format, size, date_modified, pages].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



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 123

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

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



250
251
252
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 250

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



256
257
258
259
260
261
262
263
264
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 256

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



244
245
246
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 244

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



172
173
174
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 172

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



138
139
140
141
142
 
# File 'lib/groupdocs_annotation_cloud/models/document_info.rb', line 138

def valid?
  return false if @size.nil?
  return false if @date_modified.nil?
  return true
end