Package org.spongepowered.tools.obfuscation

Enum Class SuppressedBy

java.lang.Object
java.lang.Enum<SuppressedBy>
org.spongepowered.tools.obfuscation.SuppressedBy
All Implemented Interfaces:
Serializable, Comparable<SuppressedBy>, Constable
public enum SuppressedBy extends Enum<SuppressedBy>
A centralised list of tokens supported by the AP for use in SuppressWarnings annotations. Collected here mainly for self-documentation purposes.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    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
    Description
    String
    getToken()
    Get the string token which is used in the SuppressWarnings annotation
    static SuppressedBy
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SuppressedBy[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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 Details

    • values

      public static SuppressedBy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SuppressedBy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getToken

      public String getToken()
      Get the string token which is used in the SuppressWarnings annotation