mirrors/bitcoinj
1
0
Fork 0
mirror of https://github.com/bitcoinj/bitcoinj.git synced 2025-01-19 05:33:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

base/package-info.java: add the "deprecation exception" rule to package comment

Browse Source
This commit is contained in:
Sean Gilligan 2022-08-09 19:41:37 -07:00 committed by Andreas Schildbach
parent c298a2987e
commit 4e3bf65865
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
core/src/main/java/org/bitcoinj/base/package-info.java
View File

@ -22,6 +22,13 @@
* <li>No API dependencies on external libraries other than the core JDK</li>
* <li>Implementation dependencies on Guava are allowed for now (but should be avoided as much as possible)</li>
* </ul>
* <p>
* <b>Temporary exception:</b> In the 0.17 release, we are allowing some dependencies on other packages, e.g. to
* {@link org.bitcoinj.core.NetworkParameters} provided that those references are in <b>deprecated</b> methods. This will
* smooth migration by allowing users to, for example, replace {@code import org.bitcoinj.base.Address} with
* {@code import org.bitcoinj.core.Address} as first step of conversion and remove usages of the deprecated methods in
* a second step.
* <p>
* The base package will help us make bitcoinj more modular as we will use it to break circular dependencies
* between existing packages. We are also considering splitting {@code base} into a separate JAR/module in a
* future release.