Class: GroupDocsViewerCloud::PageRotation

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_viewer_cloud/models/page_rotation.rb

Overview

Clockwise page rotation

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PageRotation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 79

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

  if attributes.key?(:'RotationAngle')
    self.rotation_angle = attributes[:'RotationAngle']
  end

end

Instance Attribute Details

#page_number ⇒ Object

Page number to rotate



35
36
37
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 35

def page_number
  @page_number
end

#rotation_angle ⇒ Object

Rotation angle



38
39
40
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 38

def rotation_angle
  @rotation_angle
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 62

def self.attribute_map
  {
    :'page_number' => :'PageNumber',
    :'rotation_angle' => :'RotationAngle'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 70

def self.swagger_types
  {
    :'page_number' => :'Integer',
    :'rotation_angle' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 136

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      page_number == other.page_number &&
      rotation_angle == other.rotation_angle
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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 188

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 255

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



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

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


145
146
147
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 151

def hash
  [page_number, rotation_angle].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



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 97

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

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



235
236
237
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 235

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



241
242
243
244
245
246
247
248
249
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 241

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



229
230
231
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 229

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



157
158
159
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 157

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



112
113
114
115
116
117
118
 
# File 'lib/groupdocs_viewer_cloud/models/page_rotation.rb', line 112

def valid?
  return false if @page_number.nil?
  return false if @rotation_angle.nil?
  rotation_angle_validator = EnumAttributeValidator.new('String', ["On90Degree", "On180Degree", "On270Degree"])
  return false unless rotation_angle_validator.valid?(@rotation_angle)
  return true
end