me.lucko.shadow

Enum ShadowingStrategy.ForShadows

java.lang.Object

java.lang.Enum<ShadowingStrategy.ForShadows>

me.lucko.shadow.ShadowingStrategy.ForShadows

All Implemented Interfaces:

Serializable, Comparable<ShadowingStrategy.ForShadows>, ShadowingStrategy.Unwrapper, ShadowingStrategy.Wrapper

Enclosing class:

ShadowingStrategy

public static enum ShadowingStrategy.ForShadows
extends Enum<ShadowingStrategy.ForShadows>
implements ShadowingStrategy.Wrapper, ShadowingStrategy.Unwrapper

A (un)wrapper which wraps and unwraps basic shadow objects.

This is applied by default when a ShadowingStrategy is not defined.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
@NonNull Class<?>	unwrap(Class<?> wrappedClass, @NonNull ShadowFactory shadowFactory)
@Nullable Object	unwrap(@Nullable Object wrapped, @NonNull Class<?> expectedType, @NonNull ShadowFactory shadowFactory) Unwraps the given object to a non-shadow object.
static ShadowingStrategy.ForShadows	valueOf(String name) Returns the enum constant of this type with the specified name.
static ShadowingStrategy.ForShadows[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
@Nullable Object	wrap(@Nullable Object unwrapped, @NonNull Class<?> expectedType, @NonNull ShadowFactory shadowFactory) Wraps the given object to a shadow.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface me.lucko.shadow.ShadowingStrategy.Unwrapper

unwrapAll, unwrapAll

Enum Constant Detail

INSTANCE

public static final ShadowingStrategy.ForShadows INSTANCE

Method Detail

values

public static ShadowingStrategy.ForShadows[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ShadowingStrategy.ForShadows c : ShadowingStrategy.ForShadows.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ShadowingStrategy.ForShadows valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

wrap

public @Nullable Object wrap(@Nullable Object unwrapped,
                             @NonNull Class<?> expectedType,
                             @NonNull ShadowFactory shadowFactory)

Description copied from interface: ShadowingStrategy.Wrapper

Wraps the given object to a shadow.

Specified by:

wrap in interface ShadowingStrategy.Wrapper

Parameters:

unwrapped - the object being returned (not a shadow)

expectedType - the expected type of the object (possibly a shadow)

shadowFactory - the shadow factory

Returns:

the wrapped value

unwrap

public @Nullable Object unwrap(@Nullable Object wrapped,
                               @NonNull Class<?> expectedType,
                               @NonNull ShadowFactory shadowFactory)

Description copied from interface: ShadowingStrategy.Unwrapper

Unwraps the given object to a non-shadow object.

Specified by:

unwrap in interface ShadowingStrategy.Unwrapper

Parameters:

wrapped - the object (possibly a shadow)

expectedType - the expected type of the object

shadowFactory - the shadow factory

Returns:

the unwrapped value

unwrap

public @NonNull Class<?> unwrap(Class<?> wrappedClass,
                                @NonNull ShadowFactory shadowFactory)

Specified by:

unwrap in interface ShadowingStrategy.Unwrapper