src/jdk.jdeps/share/classes/com/sun/tools/jdeprscan/readme.md
changeset 48942 a6c4b85163c1
parent 48322 0cd5e2ca53dd
equal deleted inserted replaced
48941:4f11514fe783 48942:a6c4b85163c1
     1 <!--
     1 <!--
     2 
     2 
     3 Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
     3 Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
     4 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     5 
     5 
     6 This code is free software; you can redistribute it and/or modify it
     6 This code is free software; you can redistribute it and/or modify it
     7 under the terms of the GNU General Public License version 2 only, as
     7 under the terms of the GNU General Public License version 2 only, as
     8 published by the Free Software Foundation.  Oracle designates this
     8 published by the Free Software Foundation.  Oracle designates this
   132 **EXAMPLE OUTPUT**
   132 **EXAMPLE OUTPUT**
   133 
   133 
   134 The output is a report that lists program elements that use deprecated
   134 The output is a report that lists program elements that use deprecated
   135 APIs. Output is subject to change.
   135 APIs. Output is subject to change.
   136 
   136 
   137 Consider the following declarations from Java SE 9:
   137 Consider the following declarations:
   138 
   138 
   139         // java.lang.Boolean
   139         // java.lang.Boolean
   140 
   140 
   141         @Deprecated(since="9")
   141         @Deprecated(since="9")
   142         public Boolean(boolean value)
   142         public Boolean(boolean value)
   143 
   143 
   144         // java.lang.Runtime
   144         // java.lang.Thread
   145 
   145 
   146         @Deprecated(since="1.2", forRemoval=true)
   146         @Deprecated(since="1.5", forRemoval=true)
   147         public static void runFinalizersOnExit(boolean value)
   147         public void destroy()
   148 
   148 
   149 Running **jdeprscan** over a class that calls these methods will result
   149 Running **jdeprscan** over a class that calls these methods will result
   150 in output something like the following:
   150 in output something like the following:
   151 
   151 
   152         class Example uses method java/lang/Boolean.<init>(Z)V deprecated
   152         class Example uses method java/lang/Boolean.<init>(Z)V deprecated
   153         class Example uses method java/lang/Runtime.runFinalizersOnExit(Z)V deprecated for removal
   153         class Example uses method java/lang/Thread.destroy()V deprecated for removal
   154 
   154 
   155 Running **jdeprscan** with the `--list` option will result in output
   155 Running **jdeprscan** with the `--list` option will result in output
   156 including something like the following:
   156 including something like the following:
   157 
   157 
   158         ...
   158         ...
   159         @Deprecated(since="9") java.lang.Boolean(boolean)
   159         @Deprecated(since="9") java.lang.Boolean(boolean)
   160         @Deprecated(since="1.2", forRemoval=true) void java.lang.Runtime.runFinalizersOnExit(boolean)
   160         @Deprecated(since="1.5", forRemoval=true) void java.lang.Thread.destroy()
   161         ...
   161         ...
   162 
   162 
   163 **NOTES**
   163 **NOTES**
   164 
   164 
   165 The **jdeprscan** tool operates by opening Java class files and
   165 The **jdeprscan** tool operates by opening Java class files and