Class: Nexpose::IPRange

Inherits:

Object

• Object
• Nexpose::IPRange

Includes:

Comparable

Defined in:

lib/nexpose/site.rb

Overview

Description

Object that represents a single IP address or an inclusive range of IP addresses. If to is nil then the from field will be used to specify a single IP Address only.

Instance Attribute Summary

• #from ⇒ Object

  Start of range *Required.

• #to ⇒ Object

  End of range *Optional (If nil then IPRange is a single IP Address).

Instance Method Summary

• #<=>(other) ⇒ Object
• #eql?(other) ⇒ Boolean
• #hash ⇒ Object
• #initialize(from, to = nil) ⇒ IPRange constructor

  A new instance of IPRange.

• #to_xml ⇒ Object
• #to_xml_elem ⇒ Object

Constructor Details

#initialize(from, to = nil) ⇒ IPRange

Returns a new instance of IPRange.

# File 'lib/nexpose/site.rb', line 717

def initialize(from, to = nil)
  @from = IPAddr.new(from)
  @to = IPAddr.new(to) if to
end

Instance Attribute Details

#from ⇒ Object

Start of range *Required

# File 'lib/nexpose/site.rb', line 713

def from
  @from
end

#to ⇒ Object

End of range *Optional (If nil then IPRange is a single IP Address)

# File 'lib/nexpose/site.rb', line 715

def to
  @to
end

Instance Method Details

#<=>(other) ⇒ Object

# File 'lib/nexpose/site.rb', line 724

def <=>(other)
  to_xml <=> other.to_xml
end

#eql?(other) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/nexpose/site.rb', line 728

def eql?(other)
  to_xml == other.to_xml
end

#hash ⇒ Object

# File 'lib/nexpose/site.rb', line 732

def hash
  to_xml.hash
end

#to_xml ⇒ Object

# File 'lib/nexpose/site.rb', line 742

def to_xml
  to_xml_elem.to_s
end

#to_xml_elem ⇒ Object

# File 'lib/nexpose/site.rb', line 736

def to_xml_elem
  xml = REXML::Element.new('range')
  xml.add_attributes({'from' => @from, 'to' => @to})
  xml
end