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

net.bytebuddy.description.ByteCodeElement 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;

import net.bytebuddy.description.annotation.AnnotationSource;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
import net.bytebuddy.matcher.FilterableList;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Implementations describe an element represented in byte code, i.e. a type, a field or a method or a constructor.
 */
public interface ByteCodeElement extends NamedElement.WithRuntimeName,
        NamedElement.WithDescriptor,
        ModifierReviewable.OfByteCodeElement,
        DeclaredByType,
        AnnotationSource {

    /**
     * 

* Checks if this element is visible from a given type. Visibility is a wider criteria then accessibility which can be checked by * {@link ByteCodeElement#isAccessibleTo(TypeDescription)}. Visibility allows the invocation of a method on itself or on external * instances. *

*

* Note: A method or field might define a signature that includes types that are not visible to a type. Such methods can be * legally invoked from this type and can even be implemented as bridge methods by this type. It is however not legal to declare * a method with invisible types in its signature that are not bridges what might require additional validation. *

*

* Important: Virtual byte code elements, i.e. virtual methods, are only considered visible if the type they are invoked upon * is visible to a given type. The visibility of such virtual members can therefore not be determined by only investigating the invoked * method but requires an additional check of the target type. *

* * @param typeDescription The type which is checked for its visibility of this element. * @return {@code true} if this element is visible for {@code typeDescription}. */ boolean isVisibleTo(TypeDescription typeDescription); /** *

* Checks if this element is accessible from a given type. Accessibility is a more narrow criteria then visibility which can be * checked by {@link ByteCodeElement#isVisibleTo(TypeDescription)}. Accessibility allows the invocation of a method on external * instances or on itself. Methods that can be invoked from within an instance might however not be considered accessible. *

*

* Note: A method or field might define a signature that includes types that are not visible to a type. Such methods can be * legally invoked from this type and can even be implemented as bridge methods by this type. It is however not legal to declare * a method with invisible types in its signature that are not bridges what might require additional validation. *

*

* Important: Virtual byte code elements, i.e. virtual methods, are only considered visible if the type they are invoked upon * is visible to a given type. The visibility of such virtual members can therefore not be determined by only investigating the invoked * method but requires an additional check of the target type. *

* * @param typeDescription The type which is checked for its accessibility of this element. * @return {@code true} if this element is accessible for {@code typeDescription}. */ boolean isAccessibleTo(TypeDescription typeDescription); /** * A type dependant describes an element that is an extension of a type definition, i.e. a field, method or method parameter. * * @param The type dependant's type. * @param The type dependant's token type. */ interface TypeDependant, S extends ByteCodeElement.Token> { /** * Returns this type dependant in its defined shape, i.e. the form it is declared in and without its type variable's resolved. * * @return This type dependant in its defined shape. */ T asDefined(); /** * Returns a token representative of this type dependant. All types that are matched by the supplied matcher are replaced by * {@link net.bytebuddy.dynamic.TargetType} descriptions. * * @param matcher A matcher to identify types to be replaced by {@link net.bytebuddy.dynamic.TargetType} descriptions. * @return A token representative of this type dependant. */ S asToken(ElementMatcher matcher); } /** * A byte code element that is declared by a type. */ interface Member extends DeclaredByType.WithMandatoryDeclaration, ByteCodeElement, NamedElement.WithGenericName { /* empty */ } /** * A token representing a byte code element. * * @param The type of the implementation. */ interface Token> { /** * Transforms the types represented by this token by applying the given visitor to them. * * @param visitor The visitor to transform all types that are represented by this token. * @return This token with all of its represented types transformed by the supplied visitor. */ T accept(TypeDescription.Generic.Visitor visitor); /** * A list of tokens. * * @param The actual token type. */ class TokenList> extends FilterableList.AbstractBase> { /** * The tokens that this list represents. */ private final List tokens; /** * Creates a list of tokens. * * @param token The tokens that this list represents. */ @SuppressWarnings("unchecked") public TokenList(S... token) { this(Arrays.asList(token)); } /** * Creates a list of tokens. * * @param tokens The tokens that this list represents. */ public TokenList(List tokens) { this.tokens = tokens; } /** * Transforms all tokens that are represented by this list. * * @param visitor The visitor to apply to all tokens. * @return A list containing the transformed tokens. */ public TokenList accept(TypeDescription.Generic.Visitor visitor) { List tokens = new ArrayList(this.tokens.size()); for (S token : this.tokens) { tokens.add(token.accept(visitor)); } return new TokenList(tokens); } @Override protected TokenList wrap(List values) { return new TokenList(values); } /** * {@inheritDoc} */ public S get(int index) { return tokens.get(index); } /** * {@inheritDoc} */ public int size() { return tokens.size(); } } } }