org.spongepowered.tools.obfuscation

Enum SuppressedBy

java.lang.Object

java.lang.Enum<SuppressedBy>

org.spongepowered.tools.obfuscation.SuppressedBy

All Implemented Interfaces:

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

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

A centralised list of tokens supported by the AP for use in SuppressWarnings annotations. Collected here mainly for self-documentation purposes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTRAINTS Suppress warnings for constraint violations Usage: @SuppressWarnings('constraints')
DEFAULT_PACKAGE Suppress warnings when a mixin target specified by name is located in the default package Usage: @SuppressWarnings('default-package')
MAPPING Suppress warnings when a class, method or field mapping cannot be located Usage: @SuppressWarnings('mapping')
OVERWRITE Suppress warnings for when an @Overwrite method is missing javadoc, or author or reason tags Usage: @SuppressWarnings('overwrite')
PUBLIC_TARGET Suppress warnings when a mixin target is resolved by the AP as visible but cannot be referenced with a class literal for some reason Usage: @SuppressWarnings('public-target')
RAW_TYPES The default java "raw types" suppressions Usage: @SuppressWarnings('rawtypes')
TARGET Suppress warnings when an injector target cannot be found Usage: @SuppressWarnings('target')
UNRESOLVABLE_TARGET Suppress warning when a mixin target is resolved by the AP as imaginary (unresolvable via Mirror at compile time), for example for anonymous inner classes or other synthetic member classes Usage: @SuppressWarnings('unresolvable-target')
VISIBILITY Suppress warnings about overwrite visibility upgrading/downgrading target visibility Usage: @SuppressWarnings('visibility')

Method Summary

Modifier and Type	Method and Description
java.lang.String	getToken() Get the string token which is used in the SuppressWarnings annotation
static SuppressedBy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SuppressedBy[]	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

CONSTRAINTS

public static final SuppressedBy CONSTRAINTS

Suppress warnings for constraint violations

Usage: @SuppressWarnings('constraints')

VISIBILITY

public static final SuppressedBy VISIBILITY

Suppress warnings about overwrite visibility upgrading/downgrading target visibility

Usage: @SuppressWarnings('visibility')

TARGET

public static final SuppressedBy TARGET

Suppress warnings when an injector target cannot be found

Usage: @SuppressWarnings('target')

MAPPING

public static final SuppressedBy MAPPING

Suppress warnings when a class, method or field mapping cannot be located

Usage: @SuppressWarnings('mapping')

OVERWRITE

public static final SuppressedBy OVERWRITE

Suppress warnings for when an @Overwrite method is missing javadoc, or author or reason tags

Usage: @SuppressWarnings('overwrite')

DEFAULT_PACKAGE

public static final SuppressedBy DEFAULT_PACKAGE

Suppress warnings when a mixin target specified by name is located in the default package

Usage: @SuppressWarnings('default-package')

PUBLIC_TARGET

public static final SuppressedBy PUBLIC_TARGET

Suppress warnings when a mixin target is resolved by the AP as visible but cannot be referenced with a class literal for some reason

Usage: @SuppressWarnings('public-target')

UNRESOLVABLE_TARGET

public static final SuppressedBy UNRESOLVABLE_TARGET

Suppress warning when a mixin target is resolved by the AP as imaginary (unresolvable via Mirror at compile time), for example for anonymous inner classes or other synthetic member classes

Usage: @SuppressWarnings('unresolvable-target')

RAW_TYPES

public static final SuppressedBy RAW_TYPES

The default java "raw types" suppressions

Usage: @SuppressWarnings('rawtypes')

Method Detail

values

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

Returns:

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

valueOf

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

getToken

public java.lang.String getToken()

Get the string token which is used in the SuppressWarnings annotation