Skip to main content

Replace com.sun.awt.AWTUtilities static method invocations

org.openrewrite.java.migrate.ReplaceComSunAWTUtilitiesMethods

This recipe replaces several static calls in com.sun.awt.AWTUtilities with the JavaSE 11 equivalent. The methods replaced are AWTUtilities.isTranslucencySupported(), AWTUtilities.setWindowOpacity(), AWTUtilities.getWindowOpacity(), AWTUtilities.getWindowShape(), AWTUtilities.isWindowOpaque(), AWTUtilities.isTranslucencyCapable() and AWTUtilities.setComponentMixingCutoutShape().

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringgetAWTIsWindowsTranslucencyPatternOptional. The method pattern to match and replace.com.sun.awt.AWTUtilities isTranslucencySupported(com.sun.awt.AWTUtilities.Translucency)
StringisWindowOpaquePatternOptional. The method pattern to match and replace.com.test.AWTUtilities isWindowOpaque(java.awt.Window)
StringisTranslucencyCapablePatternOptional. The method pattern to match and replace.com.test.AWTUtilities isTranslucencyCapable(java.awt.GraphicsConfiguration)
StringsetWindowOpacityPatternOptional. The method pattern to match and replace.com.test.AWTUtilities setWindowOpacity(java.awt.Window, float)
StringgetWindowOpacityPatternOptional. The method pattern to match and replace.com.test.AWTUtilities getWindowOpacity(java.awt.Window)
StringgetWindowShapePatternOptional. The method pattern to match and replace.com.test.AWTUtilitiesTest getWindowShape(java.awt.Window)
StringsetComponentMixingCutoutShapePatternOptional. The method pattern to match and replace.com.test.AWTUtilities setComponentMixingCutoutShape(java.awt.Component,java.awt.Shape)

Example​

Parameters​
ParameterValue
getAWTIsWindowsTranslucencyPatterncom.test.AWTUtilitiesTest isTranslucencySupported1(com.test.AWTUtilitiesTest.Translucency)
isWindowOpaquePatterncom.test.AWTUtilitiesTest isWindowOpaque(java.awt.Window)
isTranslucencyCapablePatterncom.test.AWTUtilitiesTest isTranslucencyCapable(java.awt.GraphicsConfiguration)
setWindowOpacityPatterncom.test.AWTUtilitiesTest setWindowOpacity(java.awt.Window,float)
getWindowOpacityPatterncom.test.AWTUtilitiesTest getWindowOpacity(java.awt.Window)
getWindowShapePatterncom.test.AWTUtilitiesTest getWindowShape(java.awt.Window)
setComponentMixingCutoutShapePatterncom.test.AWTUtilitiesTest setComponentMixingCutoutShape(java.awt.Component,java.awt.Shape)
Before​
package com.test;
import com.test.AWTUtilitiesTest;
import java.awt.Window;
import java.awt.*;
import javax.swing.*;
import java.awt.geom.Ellipse2D;

class Test {
    void foo() {
        Window win = new Window(new JFrame("test"));
        boolean f = AWTUtilitiesTest.isWindowOpaque(win);
        AWTUtilitiesTest.setWindowOpacity(win,1);
        float l = AWTUtilitiesTest.getWindowOpacity(win);
        Shape sh = AWTUtilitiesTest.getWindowShape(win);
        GraphicsConfiguration gc = null;
        boolean f = AWTUtilitiesTest.isTranslucencyCapable(gc);
        Component c = null;
        Shape sh = new Ellipse2D.Double(0, 0, c.getWidth(), c.getHeight());
        AWTUtilitiesTest.setComponentMixingCutoutShape(c, sh);
    }
}
After​
package com.test;
import java.awt.Window;
import java.awt.*;
import javax.swing.*;
import java.awt.geom.Ellipse2D;

class Test {
    void foo() {
        Window win = new Window(new JFrame("test"));
        boolean f = win.isOpaque();
        win.setOpacity(1);
        float l = win.getOpacity();
        Shape sh = win.getShape();
        GraphicsConfiguration gc = null;
        boolean f = gc.isTranslucencyCapable();
        Component c = null;
        Shape sh = new Ellipse2D.Double(0, 0, c.getWidth(), c.getHeight());
        c.setMixingCutoutShape(sh);
    }
}

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.migrate.ReplaceComSunAWTUtilitiesMethods")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.8.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Anu Ramamoorthy, Jonathan Schnéider, Tim te Beek