com.ui4j.bytebuddy.instrumentation.ByteCodeElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ui4j-all Show documentation

Web Automation for Java

There is a newer version: 2.1.0

package com.ui4j.bytebuddy.instrumentation;

import com.ui4j.bytebuddy.instrumentation.attribute.annotation.AnnotatedElement;
import com.ui4j.bytebuddy.instrumentation.type.DeclaredInType;
import com.ui4j.bytebuddy.instrumentation.type.TypeDescription;

/**
 * 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, ModifierReviewable, DeclaredInType, AnnotatedElement {

    /**
     * Returns the internal internalName of this byte code element.
     *
     * @return The internal internalName of this byte code element as used within the Java class file format.
     */
    String getInternalName();

    /**
     * Returns the name of this byte code element as it is defined in Java source code. This means:
     * 
     * For type descriptions, the main distinction is the display of arrays whose actual names are blended
     * with internal names when calling {@link com.ui4j.bytebuddy.instrumentation.ByteCodeElement#getName()}.
     * For method descriptions, representations of constructors and the type initializer, return the
     * empty string.
     * 
     *
     * @return The name of this type as represented in Java source code.
     */
    String getSourceCodeName();

    /**
     * Returns the descriptor of this byte code element.
     *
     * @return The descriptor of this byte code element.
     */
    String getDescriptor();

    /**
     * Returns the generic signature of this byte code element.
     *
     * @return The generic signature or {@code null} if this element is not generic.
     */
    String getGenericSignature();

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