All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.bytebuddy.description.method.MethodList Maven / Gradle / Ivy

Go to download

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2
Show newest version
/*
 * Copyright 2014 - Present Rafael Winterhalter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.bytebuddy.description.method;

import net.bytebuddy.description.ByteCodeElement;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
import net.bytebuddy.matcher.FilterableList;
import net.bytebuddy.utility.ConstructorComparator;
import net.bytebuddy.utility.GraalImageCode;
import net.bytebuddy.utility.MethodComparator;

import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * Implementations represent a list of method descriptions.
 *
 * @param  The type of method descriptions represented by this list.
 */
public interface MethodList extends FilterableList> {

    /**
     * Transforms the list of method descriptions into a list of detached tokens. All types that are matched by the provided
     * target type matcher are substituted by {@link net.bytebuddy.dynamic.TargetType}.
     *
     * @param matcher A matcher that indicates type substitution.
     * @return The transformed token list.
     */
    ByteCodeElement.Token.TokenList asTokenList(ElementMatcher matcher);

    /**
     * Returns a list of signature tokens for this list of methods.
     *
     * @return A list of signature tokens for this list of methods.
     */
    List asSignatureTokenList();

    /**
     * Returns a list of signature tokens for this list of methods.
     *
     * @param matcher         A matcher for resolving methods to {@link net.bytebuddy.description.method.MethodDescription.Token}s.
     * @param typeDescription The type description to resolve the {@link net.bytebuddy.description.method.MethodDescription.SignatureToken}s to.
     * @return A list of signature tokens for this list of methods.
     */
    List asSignatureTokenList(ElementMatcher matcher, TypeDescription typeDescription);

    /**
     * Returns this list of these method descriptions resolved to their defined shape.
     *
     * @return A list of methods in their defined shape.
     */
    MethodList asDefined();

    /**
     * A base implementation of a {@link MethodList}.
     *
     * @param  The type of method descriptions represented by this list.
     */
    abstract class AbstractBase extends FilterableList.AbstractBase> implements MethodList {

        @Override
        protected MethodList wrap(List values) {
            return new Explicit(values);
        }

        /**
         * {@inheritDoc}
         */
        public ByteCodeElement.Token.TokenList asTokenList(ElementMatcher matcher) {
            List tokens = new ArrayList(size());
            for (MethodDescription methodDescription : this) {
                tokens.add(methodDescription.asToken(matcher));
            }
            return new ByteCodeElement.Token.TokenList(tokens);
        }

        /**
         * {@inheritDoc}
         */
        public List asSignatureTokenList() {
            List tokens = new ArrayList(size());
            for (MethodDescription methodDescription : this) {
                tokens.add(methodDescription.asSignatureToken());
            }
            return tokens;
        }

        /**
         * {@inheritDoc}
         */
        public List asSignatureTokenList(ElementMatcher matcher, TypeDescription typeDescription) {
            List tokens = new ArrayList(size());
            for (MethodDescription methodDescription : this) {
                tokens.add(methodDescription.asToken(matcher).asSignatureToken(typeDescription));
            }
            return tokens;
        }

        /**
         * {@inheritDoc}
         */
        public MethodList asDefined() {
            List declaredForms = new ArrayList(size());
            for (MethodDescription methodDescription : this) {
                declaredForms.add(methodDescription.asDefined());
            }
            return new Explicit(declaredForms);
        }
    }

    /**
     * A method list implementation that returns all loaded byte code methods (methods and constructors) that
     * are declared for a given type.
     */
    class ForLoadedMethods extends AbstractBase {

        /**
         * The loaded methods that are represented by this method list.
         */
        private final List methods;

        /**
         * The loaded constructors that are represented by this method list.
         */
        private final List> constructors;

        /**
         * Creates a new list for a loaded type. Method descriptions are created on demand.
         *
         * @param type The type to be represented by this method list.
         */
        public ForLoadedMethods(Class type) {
            this(GraalImageCode.getCurrent().sorted(type.getDeclaredConstructors(), ConstructorComparator.INSTANCE),
                    GraalImageCode.getCurrent().sorted(type.getDeclaredMethods(), MethodComparator.INSTANCE));
        }

        /**
         * Creates a method list that represents the given constructors and methods in their given order. The
         * constructors are assigned the indices before the methods.
         *
         * @param constructor The constructors to be represented by the method list.
         * @param method      The methods to be represented by the method list.
         */
        public ForLoadedMethods(Constructor[] constructor, Method[] method) {
            this(Arrays.asList(constructor), Arrays.asList(method));
        }

        /**
         * Creates a method list that represents the given constructors and methods in their given order. The
         * constructors are assigned the indices before the methods.
         *
         * @param constructors The constructors to be represented by the method list.
         * @param methods      The methods to be represented by the method list.
         */
        public ForLoadedMethods(List> constructors, List methods) {
            this.constructors = constructors;
            this.methods = methods;
        }

        /**
         * {@inheritDoc}
         */
        public MethodDescription.InDefinedShape get(int index) {
            return index < constructors.size()
                    ? new MethodDescription.ForLoadedConstructor(constructors.get(index))
                    : new MethodDescription.ForLoadedMethod(methods.get(index - constructors.size()));

        }

        /**
         * {@inheritDoc}
         */
        public int size() {
            return constructors.size() + methods.size();
        }
    }

    /**
     * A method list that is a wrapper for a given list of method descriptions.
     *
     * @param  The type of method descriptions represented by this list.
     */
    class Explicit extends AbstractBase {

        /**
         * The list of methods that is represented by this method list.
         */
        private final List methodDescriptions;

        /**
         * Creates a new wrapper for a given list of methods.
         *
         * @param methodDescription The underlying list of methods used for this method list.
         */
        @SuppressWarnings("unchecked")
        public Explicit(S... methodDescription) {
            this(Arrays.asList(methodDescription));
        }

        /**
         * Creates a new wrapper for a given list of methods.
         *
         * @param methodDescriptions The underlying list of methods used for this method list.
         */
        public Explicit(List methodDescriptions) {
            this.methodDescriptions = methodDescriptions;
        }

        /**
         * {@inheritDoc}
         */
        public S get(int index) {
            return methodDescriptions.get(index);
        }

        /**
         * {@inheritDoc}
         */
        public int size() {
            return methodDescriptions.size();
        }
    }

    /**
     * A list of method descriptions for a list of detached tokens. For the returned method, each token is attached to its method representation.
     */
    class ForTokens extends AbstractBase {

        /**
         * The method's declaring type.
         */
        private final TypeDescription declaringType;

        /**
         * The list of method tokens to represent.
         */
        private final List tokens;

        /**
         * Creates a new list of method descriptions for a list of detached tokens.
         *
         * @param declaringType The method's declaring type.
         * @param token         The list of method tokens to represent.
         */
        public ForTokens(TypeDescription declaringType, MethodDescription.Token... token) {
            this(declaringType, Arrays.asList(token));
        }

        /**
         * Creates a new list of method descriptions for a list of detached tokens.
         *
         * @param declaringType The method's declaring type.
         * @param tokens        The list of method tokens to represent.
         */
        public ForTokens(TypeDescription declaringType, List tokens) {
            this.declaringType = declaringType;
            this.tokens = tokens;
        }

        /**
         * {@inheritDoc}
         */
        public MethodDescription.InDefinedShape get(int index) {
            return new MethodDescription.Latent(declaringType, tokens.get(index));
        }

        /**
         * {@inheritDoc}
         */
        public int size() {
            return tokens.size();
        }
    }

    /**
     * A list of method descriptions that yields {@link net.bytebuddy.description.method.MethodDescription.TypeSubstituting}.
     */
    class TypeSubstituting extends AbstractBase {

        /**
         * The methods' declaring type.
         */
        protected final TypeDescription.Generic declaringType;

        /**
         * The list of method descriptions to represent.
         */
        protected final List methodDescriptions;

        /**
         * The visitor to apply to each method description before returning it.
         */
        protected final TypeDescription.Generic.Visitor visitor;

        /**
         * Creates a new type substituting method list.
         *
         * @param declaringType      The methods' declaring type.
         * @param methodDescriptions The list of method descriptions to represent.
         * @param visitor            The visitor to apply to each method description before returning it.
         */
        public TypeSubstituting(TypeDescription.Generic declaringType,
                                List methodDescriptions,
                                TypeDescription.Generic.Visitor visitor) {
            this.declaringType = declaringType;
            this.methodDescriptions = methodDescriptions;
            this.visitor = visitor;
        }

        /**
         * {@inheritDoc}
         */
        public MethodDescription.InGenericShape get(int index) {
            return new MethodDescription.TypeSubstituting(declaringType, methodDescriptions.get(index), visitor);
        }

        /**
         * {@inheritDoc}
         */
        public int size() {
            return methodDescriptions.size();
        }
    }

    /**
     * An implementation of an empty method list.
     *
     * @param  The type of parameter descriptions represented by this list.
     */
    class Empty extends FilterableList.Empty> implements MethodList {

        /**
         * {@inheritDoc}
         */
        public ByteCodeElement.Token.TokenList asTokenList(ElementMatcher matcher) {
            return new ByteCodeElement.Token.TokenList();
        }

        /**
         * {@inheritDoc}
         */
        public List asSignatureTokenList() {
            return Collections.emptyList();
        }

        /**
         * {@inheritDoc}
         */
        public List asSignatureTokenList(ElementMatcher matcher, TypeDescription typeDescription) {
            return Collections.emptyList();
        }

        /**
         * {@inheritDoc}
         */
        @SuppressWarnings("unchecked")
        public MethodList asDefined() {
            return (MethodList) this;
        }
    }
}