Some modifications to @elidable: for reasons lo...

Some modifications to @elidable: for reasons lost to me now it had a
default value such that annotated methods might be elided even if the
option wasn't given. It now does nothing in that situation. Closes
#4051, #4151, no review.

1 files changed, 27 insertions, 12 deletions

diff --git a/src/library/scala/annotation/elidable.scala b/src/library/scala/annotation/elidable.scala
index 1767e044fe..ef8c20b43b 100644
--- a/src/library/scala/annotation/elidable.scala
+++ b/src/library/scala/annotation/elidable.scala
@@ -39,22 +39,34 @@ final class elidable(final val level: Int) extends annotation.StaticAnnotation {
  *  @since 2.8
  */
 object elidable {
-  final val ALL = Int.MinValue  // Level.ALL.intValue()
-  final val FINEST = 300        // Level.FINEST.intValue()
-  final val FINER = 400         // Level.FINER.intValue()
-  final val FINE = 500          // Level.FINE.intValue()
-  final val CONFIG = 700        // Level.CONFIG.intValue()
-  final val INFO = 800          // Level.INFO.intValue()
-  final val WARNING = 900       // Level.WARNING.intValue()
-  final val SEVERE = 1000       // Level.SEVERE.intValue()
-  final val OFF = Int.MaxValue  // Level.OFF.intValue()
+  /** The levels ALL and OFF are confusing in this context because the
+   *  sentiment being expressed when using the annotation is at cross purposes
+   *  with the one being expressed via -Xelide-below.  This confusion reaches
+   *  its zenith at level OFF, where the annotation means "never elide this method"
+   *  but -Xelide-below OFF is how you would say "elide everything possible."
+   *
+   *  With no simple remedy at hand, the issue is now at least documented,
+   *  and aliases MAXIMUM and MINIMUM are offered.
+   */
+  final val ALL     = Int.MinValue  // Level.ALL.intValue()
+  final val FINEST  = 300           // Level.FINEST.intValue()
+  final val FINER   = 400           // Level.FINER.intValue()
+  final val FINE    = 500           // Level.FINE.intValue()
+  final val CONFIG  = 700           // Level.CONFIG.intValue()
+  final val INFO    = 800           // Level.INFO.intValue()
+  final val WARNING = 900           // Level.WARNING.intValue()
+  final val SEVERE  = 1000          // Level.SEVERE.intValue()
+  final val OFF     = Int.MaxValue  // Level.OFF.intValue()
 
-  // and since we had to do that anyway, we can add a few of our own
+  // a couple aliases for the confusing ALL and OFF
+  final val MAXIMUM = OFF
+  final val MINIMUM = ALL
+
+  // and we can add a few of our own
   final val ASSERTION = 2000    // we should make this more granular
 
   // for command line parsing so we can use names or ints
   val byName: Map[String, Int] = Map(
-    "ALL" -> ALL,
     "FINEST" -> FINEST,
     "FINER" -> FINER,
     "FINE" -> FINE,
@@ -62,7 +74,10 @@ object elidable {
     "INFO" -> INFO,
     "WARNING" -> WARNING,
     "SEVERE" -> SEVERE,
+    "ASSERTION" -> ASSERTION,
+    "ALL" -> ALL,
     "OFF" -> OFF,
-    "ASSERTION" -> ASSERTION
+    "MAXIMUM" -> MAXIMUM,
+    "MINIMUM" -> MINIMUM
   )
 }