├── .gitignore ├── .travis.yml ├── LICENSE.md ├── README.md ├── pom.xml └── src ├── main └── java │ └── ir │ └── cafebabe │ └── math │ └── utils │ ├── BigDecimalUtils.java │ └── BigDecimalWrapper.java └── test └── java └── ir └── cafebabe └── math └── utils └── BigDecimalUtilsTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | .metadata 3 | .settings 4 | .classpath 5 | .project 6 | *.class 7 | # Package Files # 8 | *.jar 9 | *.war 10 | *.ear 11 | .idea 12 | *.iml 13 | *.swp 14 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | sudo: false 3 | script: mvn clean verify 4 | after_success: 5 | - bash <(curl -s https://codecov.io/bash) 6 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a4a8e13df7804fd6a4d5081580dc1469)](https://app.codacy.com/app/mortezaadi/bigdecimal-utils?utm_source=github.com&utm_medium=referral&utm_content=mortezaadi/bigdecimal-utils&utm_campaign=Badge_Grade_Dashboard) 2 | [![](https://jitpack.io/v/mortezaadi/bigdecimal-utils.svg)](https://jitpack.io/#mortezaadi/bigdecimal-utils) 3 | [![Maven Central](https://img.shields.io/maven-central/v/ir.cafebabe.math.utils/bigdecimal-utils.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22ir.cafebabe.math.utils%22%20AND%20a:%22bigdecimal-utils%22) 4 | [![Build Status](https://app.travis-ci.com/mortezaadi/bigdecimal-utils.svg?branch=master)](https://app.travis-ci.com/github/mortezaadi/bigdecimal-utils) 5 | [![codecov](https://codecov.io/gh/mortezaadi/bigdecimal-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/mortezaadi/bigdecimal-utils) 6 | 7 | BigDecimal Utils 8 | =============================================== 9 | Comparing BigDecimal is always hard to read and too error prone. I wrote this library 10 | to make comparison of BigDecimal more comfortable and more readable. 11 | 12 | Maven: 13 | ```xml 14 | 15 | ir.cafebabe.math.utils 16 | bigdecimal-utils 17 | 1.3 18 | 19 | ``` 20 | 21 | Gradle: 22 | 23 | compile 'ir.cafebabe.math.utils:bigdecimal-utils:1.3' 24 | 25 | Gradle Kotlin DSL: 26 | 27 | compile(group = "ir.cafebabe.math.utils", name = "bigdecimal-utils", version = "1.3") 28 | 29 | Scala SBT: 30 | 31 | libraryDependencies += "ir.cafebabe.math.utils" % "bigdecimal-utils" % "1.3" 32 | 33 | Is BigDecimal Comparison happens 34 | --------------------------------- 35 | Sure! The only reliable way to work with monetary amount is to use BigDecimal. So if you have 36 | Money somewhere in your code, you probably found yourself comparing two BigDecimals. 37 | 38 | What's wrong with BigDecimal comparison 39 | -------------------------------------- 40 | Well, As you should know, if you use **equal** method of BigDecimal to compare two objects, they only considered equal if they are equal in value and scale thus 2.0 is not equal to 2.00 when compared by 41 | **equal** method (refer to JavaDocs). 42 | 43 | To compare BigDecimal without considering their scale we should use **compareTo** method. This is 44 | the most common and correct way to compare two BigDecimals. However it is so error prone and lacks readability. 45 | To feel what it looks like, take a look at this line of code : 46 | 47 | return balance.compareTo(amount) < 0) && amount.compareTo(anotherAmount) >= 0)); 48 | 49 | The above code tris to check the condition in wich "balance < amount && amount >= anotherAmount". You 50 | definitely spotted the issue here. The **compareTo** is not clear nor readable. 51 | But how to solve this? 52 | 53 | How I Solve the Problem 54 | ------------------------ 55 | BigDecimalUtils is a simple library that enable us to campare BigDecimal objects in more readable and less error prone way. 56 | see the same comparison rewritten by this library 57 | 58 | import static ir.cafebabe.math.utils.BigDecimalUtils.*; 59 | 60 | // ... 61 | 62 | return is(balance).lt(amount) && is(amount).gte(minAmount)); 63 | 64 | **Other methods in this library:** 65 | 66 | is(bigdecimal).eq(four); // equal 67 | is(bigdecimal).gt(two); // greater than 68 | is(bigdecimal).gte(one); // greater than equal 69 | is(bigdecimal).lt(two); // less than 70 | is(bigdecimal).lte(two); // less than equal 71 | 72 | is(bigdecimal).notEq(four); // not equal 73 | is(bigdecimal).notGt(two); // not greater than 74 | is(bigdecimal).notGte(one); // not greater than equal 75 | is(bigdecimal).notLt(two); // not less than 76 | is(bigdecimal).notLte(two); // not less than equal 77 | 78 | is(bigdecimal).isZero(); 79 | is(bigdecimal).notZero(); 80 | is(bigdecimal).isPositive(); // greater than zero 81 | is(bigdecimal).isNegative(); // less than zero 82 | is(bigdecimal).isNonPositive(); // less than or equal zero 83 | is(bigdecimal).isNonNegative(); // greater than or equal zero 84 | 85 | is(bigdecimal).isNullOrZero(); // is null or zero 86 | is(bigdecimal).notNullOrZero(); // not null or zero 87 | 88 | You can also compare a BigDecimal to other numerical values. For instance instead of writing 89 | 90 | is(bigdecimal).notEq(BigDecimal.valueOf(4)); 91 | 92 | you can simply and interchangeably write: 93 | 94 | is(bigdecimal).notEq(4); 95 | is(bigdecimal).notEq(4L); 96 | is(bigdecimal).notEq(4D); 97 | 98 | Why BigDecimal Utils? 99 | -------------------------- 100 | I didn't find any library to handle BigDecimal comparison. If you found one please let me know. 101 | 102 | 103 | 104 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4.0.0 3 | ir.cafebabe.math.utils 4 | bigdecimal-utils 5 | 1.5-SNAPSHOT 6 | jar 7 | BigDecinalUtils 8 | BigDecimal utility to increase readability of using BigDecimal in calculations. 9 | http://www.cafebabe.ir 10 | 11 | 12 | 13 | The GNU Lesser General Public License, Version 2.0 14 | http://www.gnu.org/licenses/lgpl-2.0.txt 15 | 16 | 17 | 18 | 19 | https://github.com/mortezaadi/bigdecimal-utils 20 | scm:git://github.com/mortezaadi/bigdecimal-utils.git 21 | scm:git:git@github.com:mortezaadi/bigdecimal-utils.git 22 | HEAD 23 | 24 | 25 | 26 | 27 | 1 28 | Morteza Adigozalpour 29 | mortezaadi@gmail.com 30 | 31 | 32 | 33 | 34 | GitHub 35 | https://github.com/mortezaadi/bigdecimal-utils/issues 36 | 37 | 38 | 39 | 40 | ossrh 41 | https://oss.sonatype.org/content/repositories/snapshots 42 | 43 | 44 | ossrh 45 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 46 | 47 | 48 | 49 | 50 | 51 | junit 52 | junit 53 | 4.13.1 54 | test 55 | 56 | 57 | 58 | 59 | 60 | 61 | maven-deploy-plugin 62 | 2.8.2 63 | 64 | 65 | default-deploy 66 | deploy 67 | 68 | deploy 69 | 70 | 71 | 72 | 73 | 74 | org.apache.maven.plugins 75 | maven-compiler-plugin 76 | 3.2 77 | 78 | 1.6 79 | 1.6 80 | 81 | 82 | 83 | 84 | org.apache.maven.plugins 85 | maven-javadoc-plugin 86 | 87 | 88 | attach-javadocs 89 | 90 | jar 91 | 92 | 93 | 94 | 95 | 8 96 | 97 | 98 | 99 | org.apache.maven.plugins 100 | maven-release-plugin 101 | 2.5.3 102 | 103 | true 104 | false 105 | forked-path 106 | -Dgpg.passphrase=${gpg.passphrase} 107 | 108 | 109 | 110 | org.apache.maven.scm 111 | maven-scm-provider-gitexe 112 | 1.9.5 113 | 114 | 115 | 116 | 117 | org.sonatype.plugins 118 | nexus-staging-maven-plugin 119 | 1.6.7 120 | true 121 | 122 | ossrh 123 | https://oss.sonatype.org/ 124 | true 125 | 126 | 127 | 128 | org.apache.maven.plugins 129 | maven-source-plugin 130 | 3.0.1 131 | 132 | 133 | attach-sources 134 | 135 | jar 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | release-sign-artifacts 147 | 148 | 149 | performRelease 150 | true 151 | 152 | 153 | 154 | 155 | 156 | org.apache.maven.plugins 157 | maven-gpg-plugin 158 | 1.6 159 | 160 | 161 | sign-artifacts 162 | verify 163 | 164 | sign 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | -------------------------------------------------------------------------------- /src/main/java/ir/cafebabe/math/utils/BigDecimalUtils.java: -------------------------------------------------------------------------------- 1 | package ir.cafebabe.math.utils; 2 | 3 | import java.math.BigDecimal; 4 | 5 | /** 6 | * Utility to help comparison of {@link BigDecimal}. 7 | * 8 | * The only way to compare {@link BigDecimal} is to get result of compare 9 | * function of {@link BigDecimal} and compare the result with -1, 0 and 1. 10 | * 11 | * Although it is straight forward however it lacks expressiveness and decreases 12 | * readability. For instance look at this line of code : 13 | * 14 | * 
 15 |  * 
 16 |  *     if(balance.compareTo(maxAmount) < 0))
 17 |  * 
 18 |  *
19 | * 20 | * the code above try to check condition "balance < maxAmount". You 21 | * definitely spotted the problem. now imagine how hard it can be if you have to 22 | * read some code with a lot of {@link BigDecimal} comparison!! 23 | * {@link BigDecimalUtils} makes comparison of {@link BigDecimal}s more easier 24 | * and more readable than the comparator method. look how above code are written 25 | * by the help of this library. 26 | * 27 | * 
 28 |  * 
 29 |  *     if( is(balance).lt(maxAmount) )
 30 |  * 
 31 |  *
32 | * 33 | * 34 | * @author adigozalpour 35 | * 36 | */ 37 | public final class BigDecimalUtils { 38 | 39 | private BigDecimalUtils() { 40 | throw new IllegalStateException( "Utility class can not be instantiated. to start use static is() function" ); 41 | } 42 | 43 | /** 44 | * Entry points of {@link BigDecimalUtils} 45 | * 46 | * Example usage: 47 | * 48 | * 
 49 | 	 * 
 50 | 	 *      is(three).eq(four); //Equal
 51 | 	 * 		is(two).gt(two);    //Greater than
 52 | 	 * 		is(two).gte(one);   //Greater than equal
 53 | 	 * 		is(three).lt(two);  //Less than
 54 | 	 * 		is(three).lte(two); //Less than equal
 55 | 	 * 
 56 | 	 *      is(three).notEq(four); //Not Equal
 57 | 	 * 		is(two).notGt(two);    //Not Greater than
 58 | 	 * 		is(two).notGte(one);   //Not Greater than equal
 59 | 	 * 		is(three).notLt(two);  //Not Less than
 60 | 	 * 		is(three).notLte(two); //Not Less than equal
 61 | 	 * 
 62 | 	 *      is(three).isZero(); 	
 63 | 	 *      is(three).notZero(); 
 64 | 	 *      is(three).isPositive(); // greater than zero
 65 | 	 *      is(three).isNegative(); // less than zero
 66 | 	 *      is(three).isNonPositive(); //less than or equal zero
 67 | 	 *      is(three).isNonNegative(); //greater than or equal zero
 68 | 	 * 
 69 | 	 *
70 | * 71 | * @param decimal 72 | * your {@link BigDecimal}, {@link Double} or {@link Long} 73 | * 74 | * @return {@link BigDecimalWrapper} 75 | * 76 | */ 77 | public static BigDecimalWrapper is(BigDecimal decimal) { 78 | return new BigDecimalWrapper(decimal); 79 | } 80 | 81 | /** 82 | * Entry points of {@link BigDecimalUtils} 83 | * Example usage: 84 | * 85 | * 
 86 | 	 * 
 87 | 	 *      is(three).eq(four); //Equal
 88 | 	 * 		is(two).gt(two);    //Greater than
 89 | 	 * 		is(two).gte(one);   //Greater than equal
 90 | 	 * 		is(three).lt(two);  //Less than
 91 | 	 * 		is(three).lte(two); //Less than equal
 92 | 	 * 
 93 | 	 *      is(three).notEq(four); //Not Equal
 94 | 	 * 		is(two).notGt(two);    //Not Greater than
 95 | 	 * 		is(two).notGte(one);   //Not Greater than equal
 96 | 	 * 		is(three).notLt(two);  //Not Less than
 97 | 	 * 		is(three).notLte(two); //Not Less than equal
 98 | 	 * 
 99 | 	 *      is(three).isZero(); 	
100 | 	 *      is(three).notZero(); 
101 | 	 *      is(three).isPositive(); // greater than zero
102 | 	 *      is(three).isNegative(); // less than zero
103 | 	 *      is(three).isNonPositive(); //less than or equal zero
104 | 	 *      is(three).isNonNegative(); //greater than or equal zero
105 | 	 *
106 | 	 *      is(three).isNullOrZero(); //is null or zero
107 | 	 *      is(three).notNullOrZero(); //not null or zero
108 | 	 * 
109 | 	 *
110 | * 111 | * @param decimal 112 | * your {@link BigDecimal} 113 | * 114 | * @return {@link BigDecimalWrapper} 115 | * 116 | */ 117 | public static BigDecimalWrapper is(double decimal) { 118 | return is(BigDecimal.valueOf(decimal)); 119 | } 120 | 121 | public static BigDecimalWrapper is(long val) { 122 | return is(BigDecimal.valueOf(val)); 123 | } 124 | 125 | } 126 | -------------------------------------------------------------------------------- /src/main/java/ir/cafebabe/math/utils/BigDecimalWrapper.java: -------------------------------------------------------------------------------- 1 | package ir.cafebabe.math.utils; 2 | 3 | import java.math.BigDecimal; 4 | 5 | /** 6 | * wrapper of {@link BigDecimal} simplifies {@link BigDecimal} comparison 7 | * 8 | * 9 | * @author adigozalpour 10 | * 11 | */ 12 | public final class BigDecimalWrapper { 13 | 14 | private static final int ZERO = 0; 15 | private final BigDecimal bigDecimal; 16 | 17 | BigDecimalWrapper(BigDecimal bigDecimal) { 18 | this.bigDecimal = bigDecimal; 19 | } 20 | 21 | /** 22 | * Checks whether input argument is equal to the provided 23 | * {@link BigDecimal} or not; 24 | * 25 | * @param decimal value to compare 26 | * @return {@link Boolean} true if two are equal. 27 | */ 28 | public boolean eq(BigDecimal decimal) { 29 | return bigDecimal.compareTo(decimal) == ZERO; 30 | } 31 | 32 | /** 33 | * Checks whether input argument is equal to the provided 34 | * {@link Double} or not; 35 | * 36 | * @param decimal value to compare 37 | * @return {@link Boolean} true if two are equal. 38 | */ 39 | public boolean eq(double decimal) { 40 | return eq(BigDecimal.valueOf(decimal)); 41 | } 42 | 43 | /** 44 | * Checks whether input argument is equal to the provided 45 | * {@link Long} or not; 46 | * 47 | * @param val value to compare 48 | * @return {@link Boolean} true if two are equal. 49 | */ 50 | public boolean eq(long val) { 51 | return eq(BigDecimal.valueOf(val)); 52 | } 53 | 54 | /** 55 | * Checks whether input argument is greater than to the provided 56 | * {@link BigDecimal} or not; 57 | * 58 | * @param decimal value to compare 59 | * @return {@link Boolean} value 60 | */ 61 | public boolean gt(BigDecimal decimal) { 62 | return bigDecimal.compareTo(decimal) > ZERO; 63 | } 64 | 65 | /** 66 | * Checks whether input argument is greater than to the provided 67 | * {@link Double} or not; 68 | * 69 | * @param decimal value to compare 70 | * @return {@link Boolean} value 71 | */ 72 | public boolean gt(double decimal) { 73 | return gt(BigDecimal.valueOf(decimal)); 74 | } 75 | 76 | /** 77 | * Checks whether input argument is greater than to the provided 78 | * {@link Long} or not; 79 | * 80 | * @param val value to compare 81 | * @return {@link Boolean} value 82 | */ 83 | public boolean gt(long val) { 84 | return gt(BigDecimal.valueOf(val)); 85 | } 86 | 87 | /** 88 | * Checks whether input argument is greater than equal to the provided 89 | * {@link BigDecimal} or not; 90 | * 91 | * @param decimal value to compare 92 | * @return {@link Boolean} value 93 | */ 94 | public boolean gte(BigDecimal decimal) { 95 | return bigDecimal.compareTo(decimal) >= ZERO; 96 | } 97 | 98 | /** 99 | * Checks whether input argument is greater than equal to the provided 100 | * {@link Double} or not; 101 | * 102 | * @param decimal value to compare 103 | * @return {@link Boolean} value 104 | */ 105 | public boolean gte(double decimal) { 106 | return gte(BigDecimal.valueOf(decimal)); 107 | } 108 | 109 | /** 110 | * Checks whether input argument is greater than equal to the provided 111 | * {@link Long} or not; 112 | * 113 | * @param val value to compare 114 | * @return {@link Boolean} value 115 | */ 116 | public boolean gte(long val) { 117 | return gte(BigDecimal.valueOf(val)); 118 | } 119 | 120 | /** 121 | * Checks whether input argument is less than to the provided 122 | * {@link BigDecimal} or not; 123 | * 124 | * @param decimal value to compare 125 | * @return {@link Boolean} value 126 | */ 127 | public boolean lt(BigDecimal decimal) { 128 | return bigDecimal.compareTo(decimal) < ZERO; 129 | } 130 | 131 | /** 132 | * Checks whether input argument is less than to the provided 133 | * {@link Double} or not; 134 | * 135 | * @param decimal value to compare 136 | * @return {@link Boolean} value 137 | */ 138 | public boolean lt(double decimal) { 139 | return lt(BigDecimal.valueOf(decimal)); 140 | } 141 | 142 | /** 143 | * Checks whether input argument is less than to the provided 144 | * {@link Long} or not; 145 | * 146 | * @param val value to compare 147 | * @return {@link Boolean} value 148 | */ 149 | public boolean lt(long val) { 150 | return lt(BigDecimal.valueOf(val)); 151 | } 152 | 153 | /** 154 | * Checks whether input argument is less than equal to the provided 155 | * {@link BigDecimal} or not; 156 | * 157 | * @param decimal value to compare 158 | * @return {@link Boolean} value 159 | */ 160 | public boolean lte(BigDecimal decimal) { 161 | return bigDecimal.compareTo(decimal) <= ZERO; 162 | } 163 | 164 | /** 165 | * Checks whether input argument is less than equal to the provided 166 | * {@link Double} or not; 167 | * 168 | * @param decimal value to compare 169 | * @return {@link Boolean} value 170 | */ 171 | public boolean lte(double decimal) { 172 | return lte(BigDecimal.valueOf(decimal)); 173 | } 174 | 175 | /** 176 | * Checks whether input argument is less than equal to the provided 177 | * {@link Long} or not; 178 | * 179 | * @param val value to compare 180 | * @return {@link Boolean} value 181 | */ 182 | public boolean lte(long val) { 183 | return lte(BigDecimal.valueOf(val)); 184 | } 185 | 186 | /** 187 | * Checks whether input argument is not equal to the provided 188 | * {@link BigDecimal} or not; 189 | * 190 | * @param decimal value to compare 191 | * @return {@link Boolean} true if two are not equal. 192 | */ 193 | public boolean notEq(BigDecimal decimal) { 194 | return !eq(decimal); 195 | } 196 | 197 | /** 198 | * Checks whether input argument is not equal to the provided 199 | * {@link Double} or not; 200 | * 201 | * @param decimal value to compare 202 | * @return {@link Boolean} true if two are not equal. 203 | */ 204 | public boolean notEq(double decimal) { 205 | return !eq(decimal); 206 | } 207 | 208 | /** 209 | * Checks whether input argument is not equal to the provided 210 | * {@link Long} or not; 211 | * 212 | * @param val value to compare 213 | * @return {@link Boolean} true if two are not equal. 214 | */ 215 | public boolean notEq(long val) { 216 | return !eq(val); 217 | } 218 | 219 | /** 220 | * Checks whether input argument is not greater than to the provided 221 | * {@link BigDecimal} or not; 222 | * 223 | * @param decimal value to compare 224 | * @return {@link Boolean} value 225 | */ 226 | public boolean notGt(BigDecimal decimal) { 227 | return !gt(decimal); 228 | } 229 | 230 | /** 231 | * Checks whether input argument is not greater than to the provided 232 | * {@link Double} or not; 233 | * 234 | * @param decimal value to compare 235 | * @return {@link Boolean} value 236 | */ 237 | public boolean notGt(double decimal) { 238 | return !gt(decimal); 239 | } 240 | 241 | /** 242 | * Checks whether input argument is not greater than to the provided 243 | * {@link Long} or not; 244 | * 245 | * @param val value to compare 246 | * @return {@link Boolean} value 247 | */ 248 | public boolean notGt(long val) { 249 | return !gt(val); 250 | } 251 | 252 | 253 | /** 254 | * Checks whether input argument is not greater than or equal to the provided 255 | * {@link BigDecimal} or not; 256 | * 257 | * @param decimal value to compare 258 | * @return {@link Boolean} value 259 | */ 260 | public boolean notGte(BigDecimal decimal) { 261 | return !gte(decimal); 262 | } 263 | 264 | /** 265 | * Checks whether input argument is not greater than or equal to the provided 266 | * {@link Double} or not; 267 | * 268 | * @param decimal value to compare 269 | * @return {@link Boolean} value 270 | */ 271 | public boolean notGte(double decimal) { 272 | return !gte(decimal); 273 | } 274 | 275 | /** 276 | * Checks whether input argument is not greater than or equal to the provided 277 | * {@link Long} or not; 278 | * 279 | * @param val value to compare 280 | * @return {@link Boolean} value 281 | */ 282 | public boolean notGte(long val) { 283 | return !gte(val); 284 | } 285 | 286 | /** 287 | * Checks whether input argument is not less than to the provided 288 | * {@link BigDecimal} or not; 289 | * 290 | * @param decimal value to compare 291 | * @return {@link Boolean} value 292 | */ 293 | public boolean notLt(BigDecimal decimal) { 294 | return !lt(decimal); 295 | } 296 | 297 | /** 298 | * Checks whether input argument is not less than to the provided 299 | * {@link Double} or not; 300 | * 301 | * @param decimal value to compare 302 | * @return {@link Boolean} value 303 | */ 304 | public boolean notLt(double decimal) { 305 | return !lt(decimal); 306 | } 307 | 308 | /** 309 | * Checks whether input argument is not less than to the provided 310 | * {@link Long} or not; 311 | * 312 | * @param val value to compare 313 | * @return {@link Boolean} value 314 | */ 315 | public boolean notLt(long val) { 316 | return !lt(val); 317 | } 318 | 319 | /** 320 | * Checks whether input argument is not less than equal to the provided 321 | * {@link BigDecimal} or not; 322 | * 323 | * @param decimal value to compare 324 | * @return {@link Boolean} value 325 | */ 326 | public boolean notLte(BigDecimal decimal) { 327 | return !lte(decimal); 328 | } 329 | 330 | /** 331 | * Checks whether input argument is not less than equal to the provided 332 | * {@link Double} or not; 333 | * 334 | * @param decimal value to compare 335 | * @return {@link Boolean} value 336 | */ 337 | public boolean notLte(double decimal) { 338 | return !lte(decimal); 339 | } 340 | /** 341 | * Checks whether input argument is not less than equal to the provided 342 | * {@link Long} or not; 343 | * 344 | * @param val value to compare 345 | * @return {@link Boolean} value 346 | */ 347 | public boolean notLte(long val) { 348 | return !lte(val); 349 | } 350 | 351 | /** 352 | * 353 | * @return true if the value is greater than zero 354 | */ 355 | public boolean isPositive() { 356 | return gt(BigDecimal.ZERO); 357 | } 358 | 359 | /** 360 | * 361 | * @return true if the value is less than zero 362 | */ 363 | public boolean isNegative() { 364 | return lt(BigDecimal.ZERO); 365 | } 366 | 367 | /** 368 | * 369 | * @return true if the value is less than or equal with zero 370 | */ 371 | public boolean isNonPositive() { 372 | return lte(BigDecimal.ZERO); 373 | } 374 | 375 | /** 376 | * 377 | * @return true if the value is greater than or equal with zero 378 | */ 379 | public boolean isNonNegative() { 380 | return gte(BigDecimal.ZERO); 381 | } 382 | 383 | /** 384 | * 385 | * @return true if the value is equal with zero 386 | */ 387 | public boolean isZero() { 388 | return eq(BigDecimal.ZERO); 389 | } 390 | 391 | /** 392 | * 393 | * @return true if the value is greater than or less than zero 394 | */ 395 | public boolean isNotZero() { 396 | return notEq(BigDecimal.ZERO); 397 | } 398 | 399 | /** 400 | * 401 | * @return true if the value is null or zero 402 | */ 403 | public boolean isNullOrZero() { 404 | return bigDecimal == null || isZero(); 405 | } 406 | 407 | /** 408 | * 409 | * @return true if the value is not null nor zero 410 | */ 411 | public boolean notNullOrZero() { 412 | return bigDecimal != null && isNotZero(); 413 | } 414 | 415 | public BigDecimal getBigDecimal() { 416 | return bigDecimal; 417 | } 418 | } -------------------------------------------------------------------------------- /src/test/java/ir/cafebabe/math/utils/BigDecimalUtilsTest.java: -------------------------------------------------------------------------------- 1 | package ir.cafebabe.math.utils; 2 | 3 | import static org.junit.Assert.*; 4 | 5 | import static ir.cafebabe.math.utils.BigDecimalUtils.*; 6 | 7 | import java.math.BigDecimal; 8 | 9 | import org.junit.Test; 10 | 11 | public class BigDecimalUtilsTest { 12 | 13 | private BigDecimal one = new BigDecimal("1.4201"); 14 | private BigDecimal two = new BigDecimal("3.521"); 15 | private BigDecimal three = new BigDecimal("6.521"); 16 | private BigDecimal four = new BigDecimal("6.521"); 17 | 18 | @Test 19 | public void testTwoBigdecimalsEquality() { 20 | assertTrue(is(three).eq(four)); 21 | assertTrue(is(one).eq(one)); 22 | assertFalse(is(one).eq(two)); 23 | assertTrue(is(three).eq(6.521)); 24 | assertTrue(is(1).eq(1)); 25 | } 26 | 27 | @Test 28 | public void testABigdecimalIsGratherThanTheOther() { 29 | assertFalse(is(three).gt(four)); 30 | assertFalse(is(two).gt(two)); 31 | assertTrue(is(two).gt(one)); 32 | assertTrue(is(three).gt(two)); 33 | } 34 | 35 | @Test 36 | public void testABigdecimalIsGratherThanEqualsToTheOther() { 37 | assertTrue(is(three).gte(four)); 38 | assertTrue(is(two).gte(two)); 39 | assertTrue(is(two).gte(one)); 40 | assertFalse(is(two).gte(three)); 41 | } 42 | 43 | @Test 44 | public void testABigdecimalIsLessThanTheOther() { 45 | assertFalse(is(three).lt(four)); 46 | assertFalse(is(two).lt(two)); 47 | assertTrue(is(one).lt(two)); 48 | assertTrue(is(two).lt(three)); 49 | } 50 | 51 | @Test 52 | public void testABigdecimalIsLessThanEqualsToTheOther() { 53 | assertTrue(is(three).lte(four)); 54 | assertTrue(is(two).lte(two)); 55 | assertTrue(is(one).lte(two)); 56 | assertFalse(is(three).lte(two)); 57 | } 58 | 59 | @Test 60 | public void testOneAndTwoAreNotEqual() { 61 | assertTrue(is(1).notEq(2.1)); 62 | assertTrue(is(one).notEq(two)); 63 | } 64 | 65 | @Test 66 | public void testOneInNotGreaterThanTwo() { 67 | assertTrue(is(1).notGt(2)); 68 | assertTrue(is(one).notGt(two)); 69 | assertTrue(is(one).notGt(one)); 70 | } 71 | @Test 72 | public void testOneInNotGreaterThanOrEqualWithTwo() { 73 | assertTrue(is(1).notGte(2)); 74 | assertTrue(is(one).notGte(two)); 75 | assertFalse(is(one).notGte(one)); 76 | } 77 | 78 | @Test 79 | public void testTwoInNotLessThanOne() { 80 | assertTrue(is(2.1).notLt(1)); 81 | assertTrue(is(two).notLt(one)); 82 | assertTrue(is(two).notLt(two)); 83 | } 84 | 85 | @Test 86 | public void testTwoInNotLessThanOrOne() { 87 | assertTrue(is(2).notLte(1)); 88 | assertTrue(is(two).notLte(one)); 89 | assertFalse(is(two).notLte(two)); 90 | } 91 | 92 | @Test 93 | public void testOneIsPositive() { 94 | assertTrue(is(1).isPositive()); 95 | } 96 | 97 | @Test 98 | public void testZeroIsNonPositiveAndNonNegetive() { 99 | assertTrue(is(0).isNonPositive() && is(0).isNonNegative()); 100 | } 101 | 102 | @Test 103 | public void testMinusOneIsNegetive() { 104 | assertTrue(is(-1).isNegative()); 105 | } 106 | 107 | @Test 108 | public void testMinusOneIsNotZero() { 109 | assertTrue(is(-1).isNotZero()); 110 | } 111 | 112 | @Test 113 | public void testZeroIsZero() { 114 | assertTrue(is(0).isZero()); 115 | } 116 | 117 | @Test 118 | public void testNullOrZero() { 119 | assertTrue(is(null).isNullOrZero()); 120 | assertTrue(is(0).isNullOrZero()); 121 | assertFalse(is(1).isNullOrZero()); 122 | } 123 | 124 | @Test 125 | public void testNotNullOrZero() { 126 | assertFalse(is(null).notNullOrZero()); 127 | assertFalse(is(0).notNullOrZero()); 128 | assertTrue(is(1).notNullOrZero()); 129 | } 130 | 131 | 132 | 133 | } 134 | 135 | --------------------------------------------------------------------------------