Recipe Name:
Convert DateTimeZone.forTimeZone to ZoneId.forID
Description:
Convert DateTimeZone.forTimeZone to ZoneId.forID
Level:
warning
Language:
  • java
Tags:
  • framework specific
  • java.time
  • Joda-Time
  • quality
Documentation

Migrate from org.joda.time.DateTimeZone to Java Time

Joda-Time DateTimeZone migrates to java.time ZoneId or ZoneOffset.

ZoneId is the same concept, an identifier of a time-zone.

ZoneOffset is a new concept, an offset from UTC.

Before 
    org.joda.time.DateTimeZone forID = DateTimeZone.forID(zoneId);
    org.joda.time.DateTimeZone forOffsetHours = DateTimeZone.forOffsetHours(offsetHours);
After 
    ZoneId forID = ZoneId.of(zoneId);
    ZoneOffset forOffsetHours = ZoneOffset.ofHours(offsetHours);

Note: the recipes for getName and getShortName do not map exactly to the ZoneId.getName method, this is deliberate. The Joda-Time getName and getShortName methods will return different names depending on whether the long argument(which represents an instant in time) is in daylight savings time or not. In java.time, the ZoneId getName method does not respect daylight savings time changes. In order to follow this original behaviour, we need to create a ZonedDateTime and format it using a DateTimeFormatter, this is what the recipes have been designed to do.

References
Recipe 
id: scw:java.time:Joda-Time:DateTimeZone_forTimeZone
version: 10
metadata:
  name: Convert DateTimeZone.forTimeZone to ZoneId.forID
  shortDescription: Convert DateTimeZone.forTimeZone to ZoneId.forID
  level: warning
  language: java
  enabled: true
  comment: |-
    This recipe searches for an org.joda.time.DateTimeZone static factory method and provides a fix to rewrite it to the java.time.ZoneId equivalent.
    If the return value is used as a variable assignment, the recipe will modify the type to java.time.ZoneID.

    This may introduce further problem markers in the IDE, as your variable may reference DateTimeZone methods that do not exist on java.time.ZoneId.
    Further sensei recipes are available to help migrate these invalid method names to java.time equivalents where possible.
  descriptionFile: descriptions/datetimezone.html
  tags: framework specific;java.time;Joda-Time;quality
search:
  methodcall:
    args:
      1:
        type: java.util.TimeZone
    name: forTimeZone
    type: org.joda.time.DateTimeZone
availableFixes:
- name: Convert to TimeZone.toZoneId()
  actions:
  - rewrite:
      to: '{{{ arguments }}}.toZoneId()'
  - modifyAssignedVariable:
      type: java.time.ZoneId
- name: Convert to ZoneOffset.of().getID()
  actions:
  - rewrite:
      to: ZoneOffset.of({{{ arguments}}}.getID())
  - modifyAssignedVariable:
      type: java.time.ZoneOffset