Package com.cryptomorin.xseries.reflection

Interface ReflectiveHandle<T>

Type Parameters:

T - The JVM type associated with this handle (e.g. Class, Field, Method, or Constructor)

All Known Implementing Classes:

AggregateReflectiveHandle, ClassHandle, ConstructorMemberHandle, DynamicClassHandle, EnumMemberHandle, FieldMemberHandle, FlaggedNamedMemberHandle, MemberHandle, MethodMemberHandle, MinecraftClassHandle, NamedMemberHandle, ReflectedObjectHandle, StaticClassHandle, StaticReflectiveHandle, UnknownClassHandle

public interface ReflectiveHandle<T>

Represents an object that can be used for reflection operations.

See Also:

• AggregateReflectiveHandle
• ClassHandle
• MethodMemberHandle
• FieldMemberHandle
• ConstructorMemberHandle

Method Summary

Modifier and Type	Method	Description
default @NotNull ReflectiveHandle<T>	cached()	A ReflectiveHandle that caches reflect() and jvm().
default @Nullable ReflectiveOperationException	catchError()	Deprecated. I don't think there's going to be any practical use for this method.
ReflectiveHandle<T>	copy()	Creates a new handle with the same properties.
default boolean	exists()
@NotNull ReflectiveHandle<ReflectedObject>	jvm()	Usually ReflectiveHandles return MethodHandle when possible, however this method returns the raw object using the traditional Java reflection API which can be: Field Method Constructor Class (same as its normal ReflectiveHandle)
T	reflect()	The heart of the class.
default T	reflectOrNull()	Same as reflect() except that it will return null if any ReflectiveOperationException errors occur.
default T	unreflect()	An unchecked exception version of reflect() (throws the original exception, not the a RuntimeException)
default @NotNull ReflectiveHandle<T>	unwrap()	If this handle is cached(), then unwraps the real handle and returns it, otherwise it returns the same object.

Method Details

copy

@Experimental
@Contract(value="-> new",
          pure=true)
ReflectiveHandle<T> copy()

Creates a new handle with the same properties.

exists

@Contract(pure=true)
default boolean exists()

Returns:

true if this object exists at runtime, otherwise false.

catchError

@Nullable
@Obsolete
@Deprecated
default @Nullable ReflectiveOperationException catchError()

Deprecated.

I don't think there's going to be any practical use for this method.

Catches any ReflectiveOperationException thrown by reflect()

unreflect

@NotNull
@Contract(pure=true)
default T unreflect()

An unchecked exception version of reflect() (throws the original exception, not the a RuntimeException)

Throws:

ReflectiveOperationException - throws silently.

See Also:

• reflect()
• reflectOrNull()

reflectOrNull

@Nullable
@Contract(pure=true)
default T reflectOrNull()

Same as reflect() except that it will return null if any ReflectiveOperationException errors occur.

See Also:

• reflect()
• unreflect()

reflect

@NotNull
@Contract(pure=true)
T reflect()
   throws ReflectiveOperationException

The heart of the class.

Returns:

the final JVM object that exists in this runtime.

Throws:

ReflectiveOperationException - if any errors occur while getting the object, including unknown objects, security issues, etc...

See Also:

• reflectOrNull()
• unreflect()

jvm

@NotNull
@Experimental
@Contract(pure=true)
@NotNull ReflectiveHandle<ReflectedObject> jvm()

Usually ReflectiveHandles return MethodHandle when possible, however this method returns the raw object using the traditional Java reflection API which can be:

• Field
• Method
• Constructor
• Class (same as its normal ReflectiveHandle)

Since:

14.0.0

See Also:

• ReflectedObject

cached

@NotNull
@Experimental
@Contract(value="-> new",
          pure=true)
default @NotNull ReflectiveHandle<T> cached()

A ReflectiveHandle that caches reflect() and jvm(). Using this is not recommended. Please read XReflection Performance & Caching section for more information.

Note that this cache is not immediate and instead, a copy() of the handle is created which cannot be modified.

This method should only be overridden for generic type adjustment.

Since:

14.0.0

See Also:

• unwrap()

unwrap

@NotNull
@Experimental
@Contract(pure=true)
default @NotNull ReflectiveHandle<T> unwrap()

If this handle is cached(), then unwraps the real handle and returns it, otherwise it returns the same object. This is useful when you want to access some properties of the handle.

Since:

14.0.0

See Also:

• cached()