Class: OpenHAB::CoreExt::Java::ZonedDateTime

Inherits:
Object
  • Object
show all
Includes:
Between, Time
Defined in:
lib/openhab/core_ext/java/zoned_date_time.rb

Overview

Extensions to javajava.timejava.time.ZonedDateTime

Class Attribute Summary collapse

Ephemeris Methods (see CoreExt::Ephemeris) collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Between

#between?

Class Attribute Details

.now ⇒ ZonedDateTime (readonly)

Returns:




# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 21

Class Method Details

.parse(text, formatter = nil) ⇒ ZonedDateTime

Parses a string into a ZonedDateTime object.

Parameters:

  • text (String) —

    The text to parse.

  • formatter (java.time.format.DateTimeFormatter) (defaults to: nil) —

    The formatter to use.

Returns:




# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 24

Instance Method Details

#+(other) ⇒ ZonedDateTime

Parameters:

Returns:



59
60
61
62
63
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 59

def +(other)
  return plus(other.seconds) if other.is_a?(Numeric)

  plus(other)
end

#-(other) ⇒ Duration, ZonedDateTime

Parameters:

Returns:

  • (Duration) —

    If other responds to #to_zoned_date_time

  • (ZonedDateTime) —

    If other is a TemporalAmount



46
47
48
49
50
51
52
53
54
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 46

def -(other)
  if other.respond_to?(:to_zoned_date_time)
    java.time.Duration.between(other.to_zoned_date_time, self)
  elsif other.is_a?(Numeric)
    minus(other.seconds)
  else
    minus(other)
  end
end

#<=>(other) ⇒ Integer?

Returns:



222
223
224
225
226
227
228
229
230
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 222

def <=>(other)
  # compare instants, otherwise it will differ by timezone, which we don't want
  # (use eql? if you care about that)
  if other.respond_to?(:to_zoned_date_time)
    to_instant.compare_to(other.to_zoned_date_time(self).to_instant)
  elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(self))
    lhs <=> rhs
  end
end

#coerce(other) ⇒ Array?

Converts ‘other` to OpenHAB::CoreExt::Java::ZonedDateTime, if possible

Parameters:

Returns:



252
253
254
255
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 252

def coerce(other)
  logger.trace { "Coercing #{self} as a request from #{other.class}" }
  [other.to_zoned_date_time(self), self] if other.respond_to?(:to_zoned_date_time)
end

#days_until(holiday, holiday_file = nil) ⇒ Integer

Calculate the number of days until a specific holiday

Examples:

Time.now.days_until(:christmas) # => 2

Parameters:

  • holiday (String, Symbol)
  • holiday_file (String, nil) (defaults to: nil) —

    Optional path to XML file to use for holiday definitions.

Returns:

Raises:

  • (ArgumentError) —

    if the holiday isn’t valid



211
212
213
214
215
216
217
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 211

def days_until(holiday, holiday_file = nil)
  holiday = holiday.to_s.upcase
  r = ::Ephemeris.get_days_until(*[self, holiday, holiday_file || DSL.holiday_file].compact)
  raise ArgumentError, "#{holiday.inspect} isn't a recognized holiday" if r == -1

  r
end

#holiday(holiday_file = nil) ⇒ Symbol?

Name of the holiday for this date.

Examples:

MonthDay.parse("12-25").holiday # => :christmas

Parameters:

  • holiday_file (String, nil) (defaults to: nil) —

    Optional path to XML file to use for holiday definitions.

Returns:



151
152
153
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 151

def holiday(holiday_file = nil)
  ::Ephemeris.get_bank_holiday_name(*[self, holiday_file || DSL.holiday_file].compact)&.downcase&.to_sym
end

#holiday?(holiday_file = nil) ⇒ true, false

Determines if this date is on a holiday.

Parameters:

  • holiday_file (String, nil) (defaults to: nil) —

    Optional path to XML file to use for holiday definitions.

Returns:

  • (true, false) 


161
162
163
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 161

def holiday?(holiday_file = nil)
  ::Ephemeris.bank_holiday?(*[self, holiday_file || DSL.holiday_file].compact)
end

#in_dayset?(set) ⇒ true, false

Determines if this time is during a specific dayset

Examples:

Time.now.in_dayset?("school")

Parameters:

Returns:

  • (true, false) 


196
197
198
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 196

def in_dayset?(set)
  ::Ephemeris.in_dayset?(set.to_s, self)
end

#next_holiday(holiday_file = nil) ⇒ Symbol

Name of the closest holiday on or after this date.

Parameters:

  • holiday_file (String, nil) (defaults to: nil) —

    Optional path to XML file to use for holiday definitions.

Returns:



171
172
173
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 171

def next_holiday(holiday_file = nil)
  ::Ephemeris.get_next_bank_holiday(*[self, holiday_file || DSL.holiday_file].compact).downcase.to_sym
end

#to_date ⇒ Date

Returns:



82
83
84
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 82

def to_date
  Date.new(year, month_value, day_of_month)
end

#to_f ⇒ Float

The number of seconds since the Unix epoch.

Returns:



79
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 79

delegate %i[to_i to_f] => :to_instant

#to_i ⇒ Integer

The number of seconds since the Unix epoch.

Returns:




# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 65

#to_instant ⇒ Instant

Converts this object to an Instant

Returns:



236
237
238
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 236

def to_instant(_context = nil)
  raw_to_instant
end

#to_local_date(_context = nil) ⇒ LocalDate

Returns:



87
88
89
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 87

def to_local_date(_context = nil)
  toLocalDate
end

#to_local_time(_context = nil) ⇒ LocalTime

Returns:



35
36
37
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 35

def to_local_time(_context = nil)
  toLocalTime
end

#to_month_day ⇒ MonthDay

Returns:



92
93
94
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 92

def to_month_day
  MonthDay.of(month, day_of_month)
end

#to_time ⇒ Time

Returns:




# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 98

#to_zoned_date_time(context = nil) ⇒ self

Parameters:

Returns:

  • (self) 


105
106
107
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 105

def to_zoned_date_time(context = nil) # rubocop:disable Lint/UnusedMethodArgument
  self
end

#today? ⇒ true, false

Returns true if the date, converted to the system time zone, is today.

This is the equivalent of checking if the current datetime is between midnight and end of the day of the system time zone.

Returns:

  • (true, false) 


126
127
128
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 126

def today?
  with_zone_same_instant(ZoneId.system_default).to_local_date == LocalDate.now
end

#tomorrow? ⇒ true, false

Returns true if the date, converted to the system time zone, is tomorrow.

Returns:

  • (true, false) 


135
136
137
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 135

def tomorrow?
  with_zone_same_instant(ZoneId.system_default).to_local_date == LocalDate.now + 1
end

#weekend? ⇒ true, false

Determines if this time is during a weekend.

Examples:

Time.now.weekend?

Returns:

  • (true, false) 


183
184
185
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 183

def weekend?
  ::Ephemeris.weekend?(self)
end

#yesterday? ⇒ true, false

Returns true if the date, converted to the system time zone, is yesterday.

Returns:

  • (true, false) 


114
115
116
 
# File 'lib/openhab/core_ext/java/zoned_date_time.rb', line 114

def yesterday?
  with_zone_same_instant(ZoneId.system_default).to_local_date == LocalDate.now - 1
end