Class DeprecationSupport

java.lang.Object
net.shibboleth.utilities.java.support.primitive.DeprecationSupport

public final class DeprecationSupport
extends Object
Helper methods for reporting usage of deprecated features.
  • Field Details

    • LOG_CATEGORY

      @Nonnull @NotEmpty public static final String LOG_CATEGORY
      Log category name for warnings.
      See Also:
      Constant Field Values
    • LOG

      @Nonnull private static final org.slf4j.Logger LOG
      Class logger.
    • WARNED_SET

      @Nonnull @NonnullElements private static final Set<String> WARNED_SET
      Tracks issued warnings.
  • Constructor Details

    • DeprecationSupport

      private DeprecationSupport()
      Constructor.
  • Method Details

    • warn

      public static void warn​(@Nonnull DeprecationSupport.ObjectType type, @Nonnull @NotEmpty String name, @Nullable String context, @Nullable String replacement)
      Emit a deprecation warning for an object or feature of the system.
      Parameters:
      type - type of object or feature
      name - name of object or feature
      context - surrounding context for deprecation warning
      replacement - the replacement for the deprecated feature
    • warnOnce

      public static void warnOnce​(@Nonnull DeprecationSupport.ObjectType type, @Nonnull @NotEmpty String name, @Nullable String context, @Nullable String replacement)
      Emit a deprecation warning for an object or feature of the system but limit to a single warning for the life of the process or until state is cleared.
      Parameters:
      type - type of object or feature
      name - name of object or feature
      context - surrounding context for deprecation warning
      replacement - the replacement for the deprecated feature
    • clearWarningState

      public static void clearWarningState()
      Clear the previously warned state.