net.bytebuddy.description

Interface ByteCodeElement

All Superinterfaces:

AnnotatedCodeElement, DeclaredByType, ModifierReviewable, NamedElement, NamedElement.WithRuntimeName

All Known Subinterfaces:

ByteCodeElement.Accessible, FieldDescription, FieldDescription.InDefinedShape, InstrumentedType, MethodDescription, MethodDescription.InDefinedShape, TypeDescription, TypeVariableSource

All Known Implementing Classes:

FieldDescription.AbstractBase, FieldDescription.ForLoadedField, FieldDescription.InDefinedShape.AbstractBase, FieldDescription.Latent, FieldDescription.TypeSubstituting, Implementation.Context.Default.AbstractPropertyAccessorMethod, Implementation.Context.Default.AccessorMethod, Implementation.Context.Default.CacheValueField, Implementation.Context.Default.FieldGetter, Implementation.Context.Default.FieldSetter, InstrumentedType.Default, MethodDescription.AbstractBase, MethodDescription.ForLoadedConstructor, MethodDescription.ForLoadedMethod, MethodDescription.InDefinedShape.AbstractBase, MethodDescription.Latent, MethodDescription.Latent.TypeInitializer, MethodDescription.TypeSubstituting, MethodRebaseResolver.Resolution.ForRebasedConstructor.RebasedConstructor, MethodRebaseResolver.Resolution.ForRebasedMethod.RebasedMethod, MethodTransformer.Simple.TransformedMethod, TypeDescription.AbstractBase, TypeDescription.AbstractBase.OfSimpleType, TypeDescription.ArrayProjection, TypeDescription.ForLoadedType, TypeDescription.ForPackageDescription, TypeDescription.Latent, TypePool.LazyFacade.LazyResolution.LazyTypeDescription, TypePool.LazyTypeDescription, TypeWriter.Default.ForInlining.TypeInitializerDelegate, TypeWriter.MethodPool.Record.AccessBridgeWrapper.AccessorBridge, TypeWriter.MethodPool.Record.AccessBridgeWrapper.BridgeTarget, TypeWriter.MethodPool.Record.ForDefinedMethod.OfVisibilityBridge.VisibilityBridge

public interface ByteCodeElement
extends NamedElement.WithRuntimeName, ModifierReviewable, DeclaredByType, AnnotatedCodeElement

Implementations describe an element represented in byte code, i.e. a type, a field or a method or a constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ByteCodeElement.Accessible Describes a byte code element that can be accessed by another element.
static interface	ByteCodeElement.Token<T extends ByteCodeElement.Token<T>> Representation of a tokenized, detached byte code element.
static interface	ByteCodeElement.TypeDependant<T extends ByteCodeElement.TypeDependant<?,S>,S extends ByteCodeElement.Token<S>> A type dependant describes an element that is an extension of a type definition, i.e.

Nested classes/interfaces inherited from interface net.bytebuddy.description.NamedElement

NamedElement.WithGenericName, NamedElement.WithRuntimeName

Nested classes/interfaces inherited from interface net.bytebuddy.description.ModifierReviewable

ModifierReviewable.AbstractBase

Field Summary

Fields

Modifier and Type	Field and Description
static String	NON_GENERIC_SIGNATURE The generic type signature of a non-generic byte code element.

Fields inherited from interface net.bytebuddy.description.NamedElement

EMPTY_NAME

Fields inherited from interface net.bytebuddy.description.ModifierReviewable

EMPTY_MASK

Method Summary

Modifier and Type	Method and Description
String	getDescriptor() Returns the descriptor of this byte code element.
String	getGenericSignature() Returns the generic signature of this byte code element.
boolean	isVisibleTo(TypeDescription typeDescription) Checks if this element is visible from a given type.

Methods inherited from interface net.bytebuddy.description.NamedElement.WithRuntimeName

getInternalName, getName

Methods inherited from interface net.bytebuddy.description.NamedElement

getSourceCodeName

Methods inherited from interface net.bytebuddy.description.ModifierReviewable

getModifiers, isAbstract, isAnnotation, isBridge, isClassType, isDeprecated, isEnum, isFinal, isInterface, isMandated, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrict, isSuper, isSynchronized, isSynthetic, isTransient, isVarArgs, isVolatile

Methods inherited from interface net.bytebuddy.description.DeclaredByType

getDeclaringType

Methods inherited from interface net.bytebuddy.description.annotation.AnnotatedCodeElement

getDeclaredAnnotations

Field Detail

NON_GENERIC_SIGNATURE

static final String NON_GENERIC_SIGNATURE

The generic type signature of a non-generic byte code element.

Method Detail

getDescriptor

String getDescriptor()

Returns the descriptor of this byte code element.

Returns:

The descriptor of this byte code element.

getGenericSignature

String getGenericSignature()

Returns the generic signature of this byte code element. If this element does not reference generic types or references malformed generic types, null is returned as a signature.

Returns:

The generic signature or null if this element is not generic.

isVisibleTo

boolean isVisibleTo(TypeDescription typeDescription)

Checks if this element is visible from a given type.

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.

Parameters:

typeDescription - The type which is checked for its access of this element.

Returns:

true if this element is visible for typeDescription.