org.mapstruct

Enum ReportingPolicy

java.lang.Object

java.lang.Enum<ReportingPolicy>

org.mapstruct.ReportingPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReportingPolicy>

public enum ReportingPolicy
extends java.lang.Enum<ReportingPolicy>

Policy for reporting issues occurring during the generation of a mapper implementation.

Author:

Gunnar Morling

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT When given as value for Mapper.unmappedTargetPolicy(), the setting from the configuration source referenced via Mapper.config() will be applied.
ERROR A report with Diagnostic.Kind.ERROR will be created for the given issue, causing the compilation to fail.
IGNORE No report will be created for the given issue.
WARN A report with Diagnostic.Kind.WARNING will be created for the given issue.

Method Summary

Modifier and Type	Method and Description
static ReportingPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReportingPolicy[]	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

IGNORE

public static final ReportingPolicy IGNORE

No report will be created for the given issue.

WARN

public static final ReportingPolicy WARN

A report with Diagnostic.Kind.WARNING will be created for the given issue.

ERROR

public static final ReportingPolicy ERROR

A report with Diagnostic.Kind.ERROR will be created for the given issue, causing the compilation to fail.

DEFAULT

public static final ReportingPolicy DEFAULT

When given as value for Mapper.unmappedTargetPolicy(), the setting from the configuration source referenced via Mapper.config() will be applied.

Otherwise (no configuration source is referenced, or this value is given via MapperConfig.unmappedTargetPolicy()), a report with Diagnostic.Kind.WARNING will be created for the given issue.

Method Detail

values

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

Returns:

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

valueOf

public static ReportingPolicy valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null