Allow class file locator resolution based on class file version.

Author: raphw

byte-buddy-dep/src/main/java/net/bytebuddy/build/Plugin.java

@@ -815,6 +815,16 @@ interface Engine {
          */
         Engine with(ClassFileLocator classFileLocator);
 
+        /**
+         * Uses the supplied {@link ClassFileVersion} as a base for resolving multi-release jars, or {@code null}
+         * if multi-release jars should not be resolved but be treated as regular jar files. This property might
+         * not be applied if the underlying location mechanism does not supply manual resource resolution.
+         *
+         * @param classFileVersion The class file version to use or {@code null}.
+         * @return A new plugin engine that is equal to this engine but with the supplied class file verion being used.
+         */
+        Engine with(@MaybeNull ClassFileVersion classFileVersion);
+
         /**
          * Appends the supplied listener to this engine.
          *
@@ -4464,6 +4474,13 @@ class Default extends AbstractBase {
              */
             private final ClassFileLocator classFileLocator;
 
+            /**
+             * The class file version to use for multi-release jars, or {@code null}.
+             */
+            @MaybeNull
+            @HashCodeAndEqualsPlugin.ValueHandling(HashCodeAndEqualsPlugin.ValueHandling.Sort.REVERSE_NULLABILITY)
+            private final ClassFileVersion classFileVersion;
+
             /**
              * The listener to use.
              */
@@ -4511,6 +4528,7 @@ protected Default(ByteBuddy byteBuddy, TypeStrategy typeStrategy) {
                         typeStrategy,
                         PoolStrategy.Default.FAST,
                         ClassFileLocator.NoOp.INSTANCE,
+                        null,
                         Listener.NoOp.INSTANCE,
                         new ErrorHandler.Compound(ErrorHandler.Failing.FAIL_FAST,
                                 ErrorHandler.Enforcing.ALL_TYPES_RESOLVED,
@@ -4526,6 +4544,7 @@ protected Default(ByteBuddy byteBuddy, TypeStrategy typeStrategy) {
              * @param typeStrategy       The type strategy to use.
              * @param poolStrategy       The pool strategy to use.
              * @param classFileLocator   The class file locator to use.
+             * @param classFileVersion   The class file version to use for multi-release jars, or {@code null}.
              * @param listener           The listener to use.
              * @param errorHandler       The error handler to use.
              * @param dispatcherFactory  The dispatcher factory to use.
@@ -4535,6 +4554,7 @@ protected Default(ByteBuddy byteBuddy,
                               TypeStrategy typeStrategy,
                               PoolStrategy poolStrategy,
                               ClassFileLocator classFileLocator,
+                              @MaybeNull ClassFileVersion classFileVersion,
                               Listener listener,
                               ErrorHandler errorHandler,
                               Dispatcher.Factory dispatcherFactory,
@@ -4543,6 +4563,7 @@ protected Default(ByteBuddy byteBuddy,
                 this.typeStrategy = typeStrategy;
                 this.poolStrategy = poolStrategy;
                 this.classFileLocator = classFileLocator;
+                this.classFileVersion = classFileVersion;
                 this.listener = listener;
                 this.errorHandler = errorHandler;
                 this.dispatcherFactory = dispatcherFactory;
@@ -4613,6 +4634,7 @@ public Engine with(ByteBuddy byteBuddy) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         errorHandler,
                         dispatcherFactory,
@@ -4627,6 +4649,7 @@ public Engine with(TypeStrategy typeStrategy) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         errorHandler,
                         dispatcherFactory,
@@ -4641,6 +4664,7 @@ public Engine with(PoolStrategy poolStrategy) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         errorHandler,
                         dispatcherFactory,
@@ -4655,6 +4679,22 @@ public Engine with(ClassFileLocator classFileLocator) {
                         typeStrategy,
                         poolStrategy,
                         new ClassFileLocator.Compound(this.classFileLocator, classFileLocator),
+                        classFileVersion,
+                        listener,
+                        errorHandler,
+                        dispatcherFactory,
+                        ignoredTypeMatcher);
+            }
+
+            /**
+             * {@inheritDoc}
+             */
+            public Engine with(@MaybeNull ClassFileVersion classFileVersion) {
+                return new Default(byteBuddy,
+                        typeStrategy,
+                        poolStrategy,
+                        classFileLocator,
+                        classFileVersion,
                         listener,
                         errorHandler,
                         dispatcherFactory,
@@ -4669,6 +4709,7 @@ public Engine with(Listener listener) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         new Listener.Compound(this.listener, listener),
                         errorHandler,
                         dispatcherFactory,
@@ -4683,6 +4724,7 @@ public Engine withoutErrorHandlers() {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         Listener.NoOp.INSTANCE,
                         dispatcherFactory,
@@ -4697,6 +4739,7 @@ public Engine withErrorHandlers(List<? extends ErrorHandler> errorHandlers) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         new ErrorHandler.Compound(errorHandlers),
                         dispatcherFactory,
@@ -4711,6 +4754,7 @@ public Engine with(Dispatcher.Factory dispatcherFactory) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         errorHandler,
                         dispatcherFactory,
@@ -4725,6 +4769,7 @@ public Engine ignore(ElementMatcher<? super TypeDescription> matcher) {
                         typeStrategy,
                         poolStrategy,
                         classFileLocator,
+                        classFileVersion,
                         listener,
                         errorHandler,
                         dispatcherFactory,
@@ -4755,8 +4800,8 @@ public Summary apply(Source source, Target target, List<? extends Plugin.Factory
                         }
                     }
                     Source.Origin origin = source.read();
-                    try { // TODO: class file locator.
-                        ClassFileLocator classFileLocator = new ClassFileLocator.Compound(origin.toClassFileLocator(null), this.classFileLocator);
+                    try {
+                        ClassFileLocator classFileLocator = new ClassFileLocator.Compound(origin.toClassFileLocator(classFileVersion), this.classFileLocator);
                         TypePool typePool = poolStrategy.typePool(classFileLocator);
                         Manifest manifest = origin.getManifest();
                         listener.onManifest(manifest);

byte-buddy-dep/src/test/java/net/bytebuddy/build/PluginEngineDefaultTest.java

@@ -254,7 +254,7 @@ public void testUnresolved() throws Exception {
                 Sample.class.getName().replace('.', '/') + ".class",
                 ClassFileLocator.ForClassLoader.read(Sample.class))) {
             @Override
-            public ClassFileLocator toClassFileLocator() {
+            public ClassFileLocator toClassFileLocator(ClassFileVersion classFileVersion) {
                 return ClassFileLocator.NoOp.INSTANCE;
             }
         };

byte-buddy-dep/src/test/java/net/bytebuddy/build/PluginEngineSourceInMemoryTest.java

@@ -20,9 +20,9 @@ public class PluginEngineSourceInMemoryTest {
     public void testNoManifest() throws Exception {
         Plugin.Engine.Source.Origin origin = new Plugin.Engine.Source.InMemory(Collections.singletonMap("foo/Bar.class", new byte[]{1, 2, 3})).read();
         try {
-            assertThat(origin.toClassFileLocator().locate("foo.Bar").isResolved(), is(true));
-            assertThat(origin.toClassFileLocator().locate("foo.Bar").resolve(), is(new byte[]{1, 2, 3}));
-            assertThat(origin.toClassFileLocator().locate("qux.Baz").isResolved(), is(false));
+            assertThat(origin.toClassFileLocator(null).locate("foo.Bar").isResolved(), is(true));
+            assertThat(origin.toClassFileLocator(null).locate("foo.Bar").resolve(), is(new byte[]{1, 2, 3}));
+            assertThat(origin.toClassFileLocator(null).locate("qux.Baz").isResolved(), is(false));
             assertThat(origin.getManifest(), nullValue(Manifest.class));
             Iterator<Plugin.Engine.Source.Element> iterator = origin.iterator();
             assertThat(iterator.hasNext(), is(true));