Recipe Name:
Rewrite getWeekyear() to java.time equivalent
Description:
Rewrite getWeekyear() to java.time equivalent
Level:
warning
Language:
  • java
Tags:
  • framework specific
  • java.time
  • Joda-Time
  • quality
Documentation

getWeekyear() is no longer available

Joda-Time provided a convenience method to get the Week-Based year from a Date-related object.

java.time has removed this convenience method. Additionally, there is new behaviour available surrounding week-based years.

The calculation of Week-based years depends upon which day is considered to be the start of the week, and also how many days minimum should be in the first week of the year.

Joda-Time getWeekyear() followed the ISO standard for these rules which considers Monday to be the start of the week.

java.time allows you to use locale-dependant Week-Based Years. Some Locales (for example the US) consider Sunday to be the start of the week.

This recipe provides 3 different fixes available depending on whether you want to migrate to the new behaviour:

  • ISO Week-based year (Same behaviour as Joda-Time)
  • Sunday-Start Week-based year
  • Locale-dependant Week-based year (using Default Locale)
Recipe 
id: scw:java.time:Joda-Time:getWeekyear
version: 10
metadata:
  name: Rewrite getWeekyear() to java.time equivalent
  shortDescription: Rewrite getWeekyear() to java.time equivalent
  level: warning
  language: java
  enabled: true
  comment: |-
    Joda-Time provided getWeekyear() method which provided a value based on an ISO8601 Week-based year.
    In java.time this method has been removed but the same value can still be accessed using the get(ChronoField) method.
    Additionally java.time provides the ability to use a Week-based year based on Locale-specific rules.
    This recipe provides fixes to transform from the previous method names to the new get(ChronoField) methods.

    This recipe is designed to match on broken code as part of an overall migration from Joda-Time to java.time.
    After an Joda-Time object has been migrated to a java.time equivalent, some subsequent method calls may become invalid as they are no longer provided by java.time.
    This recipe is designed to match on one of those method calls and provide a fix.
  descriptionFile: descriptions/getWeekyear.html
  tags: framework specific;java.time;Joda-Time;quality
search:
  methodcall:
    argCount: 0
    name: getWeekyear
    anyOf:
    - type: java.time.ZonedDateTime
    - type: java.time.OffsetDateTime
    - type: java.time.LocalDateTime
    - type: java.time.LocalDate
availableFixes:
- name: Rewrite using ISO Weekyear (Same as Joda-Time)
  actions:
  - rewrite:
      to: '{{{ qualifier }}}.get(java.time.temporal.IsoFields.WEEK_BASED_YEAR)'
- name: Rewrite using Locale-dependant Weekyear
  actions:
  - rewrite:
      to: '{{{ qualifier }}}.get(java.time.temporal.WeekFields.of(java.util.Locale.getDefault()).weekBasedYear())'
- name: Rewrite using SUNDAY_START Weekyear
  actions:
  - rewrite:
      to: '{{{ qualifier }}}.get(java.time.temporal.WeekFields.SUNDAY_START.weekBasedYear())'