Package org.hibernate.bytecode.enhance.spi

Enum UnsupportedEnhancementStrategy

java.lang.Object

java.lang.Enum<UnsupportedEnhancementStrategy>

org.hibernate.bytecode.enhance.spi.UnsupportedEnhancementStrategy

All Implemented Interfaces:

Serializable, Comparable<UnsupportedEnhancementStrategy>

@Incubating
public enum UnsupportedEnhancementStrategy
extends Enum<UnsupportedEnhancementStrategy>

The expected behavior when encountering a class that cannot be enhanced, in particular when attribute names don't match field names.

See Also:

EnhancementContext.getUnsupportedEnhancementStrategy()

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	When a class cannot be enhanced, throw an exception with an actionable message.
LEGACY	Deprecated. Use SKIP or FAIL instead.
SKIP	When a class cannot be enhanced, skip enhancement for that class only.

Method Summary

Modifier and Type	Method	Description
static UnsupportedEnhancementStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UnsupportedEnhancementStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

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

Enum Constant Detail

SKIP

public static final UnsupportedEnhancementStrategy SKIP

When a class cannot be enhanced, skip enhancement for that class only.

FAIL

public static final UnsupportedEnhancementStrategy FAIL

When a class cannot be enhanced, throw an exception with an actionable message.

LEGACY

@Deprecated
public static final UnsupportedEnhancementStrategy LEGACY

Deprecated.

Use SKIP or FAIL instead.

Legacy behavior: when a class cannot be enhanced, ignore that fact and try to enhance it anyway.

This is utterly unsafe and may cause errors, unpredictable behavior, and data loss.

Intended only for internal use in contexts with rigid backwards compatibility requirements.

Method Detail

values

public static UnsupportedEnhancementStrategy[] 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 (UnsupportedEnhancementStrategy c : UnsupportedEnhancementStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static UnsupportedEnhancementStrategy 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