Open source

Rename Jackson 2.x methods to 3.x equivalents for JsonGenerator

Recipe IDorg.openrewrite.java.jackson.UpgradeJackson_2_3_JsonGeneratorMethodRenamesArtifactorg.openrewrite.recipe:rewrite-jackson

Rename JsonGenerator methods that were renamed in 3.x (e.g., writeObject() to writePOJO(), getCurrentValue() to currentValue()).

Composite recipejackson-3Apache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.jackson.UpgradeJackson_2_3_JsonGeneratorMethodRenames")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-jackson:1.30.1")
}

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.jackson.UpgradeJackson_2_3_JsonGeneratorMethodRenames

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-jackson:RELEASE

Definition

This recipe runs the following recipes in order.

Change method name com.fasterxml.jackson.core.JsonGenerator getOutputContext() to streamWriteContextorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator getOutputTarget() to streamWriteOutputTargetorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator getOutputBuffered() to streamWriteOutputBufferedorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator canOmitFields() to canOmitPropertiesorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator getCodec() to objectWriteContextorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator getCurrentValue() to currentValueorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator setCurrentValue(..) to assignCurrentValueorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeObject(..) to writePOJOorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeArrayFieldStart(..) to writeArrayPropertyStartorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeBinaryField(..) to writeBinaryPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeBooleanField(..) to writeBooleanPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeFieldId(..) to writePropertyIdorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeFieldName(..) to writeNameorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeNullField(..) to writeNullPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeNumberField(..) to writeNumberPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeObjectField(..) to writePOJOPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeObjectFieldStart(..) to writeObjectPropertyStartorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeOmittedField(..) to writeOmittedPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writePOJOField(..) to writePOJOPropertyorg.openrewrite.java.ChangeMethodName
Change method name com.fasterxml.jackson.core.JsonGenerator writeStringField(..) to writeStringPropertyorg.openrewrite.java.ChangeMethodName

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats