README.asciidoc

   1 = Null-Analysis image:https://img.shields.io/badge/email-%40metio-brightgreen.svg?style=social&label=mail["Discuss on Google Groups", link="https://groups.google.com/forum/#!forum/metio"] image:https://img.shields.io/badge/irc-%23metio.wtf-brightgreen.svg?style=social&label=IRC["Chat on IRC", link="http://webchat.freenode.net/?channels=metio.wtf"]
   2 Sebastian Hoß <http://seb.xn--ho-hia.de/[@sebhoss]>
   3 :github-org: sebhoss
   4 :project-name: null-analysis
   5 :project-group: de.xn--ho-hia.quality
   6 :coverity-project: 9331
   7 :codacy-project: 693c2e0c381042b69f1f150a74069bad
   8
   9 image:https://img.shields.io/badge/license-cc%20zero-000000.svg?style=flat-square["CC Zero", link="http://creativecommons.org/publicdomain/zero/1.0/"]
  10 pass:[<span class="image"><a class="image" href="https://maven-badges.herokuapp.com/maven-central/de.xn--ho-hia.quality/null-analysis"><img src="https://img.shields.io/maven-central/v/de.xn--ho-hia.quality/null-analysis.svg?style=flat-square" alt="Maven Central"></a></span>]
  11 pass:[<span class="image"><a class="image" href="https://www.javadoc.io/doc/de.xn--ho-hia.quality/null-analysis"><img src="https://www.javadoc.io/badge/de.xn--ho-hia.quality/null-analysis.svg?style=flat-square&color=blue" alt="Read JavaDocs"></a></span>]
  12 image:https://reposs.herokuapp.com/?path={github-org}/{project-name}&style=flat-square["Repository size"]
  13 image:https://www.openhub.net/p/{project-name}/widgets/project_thin_badge.gif["Open Hub statistics", link="https://www.openhub.net/p/{project-name}"]
  14
  15 image:https://img.shields.io/travis/{github-org}/{project-name}/master.svg?style=flat-square["Build Status", link="https://travis-ci.org/{github-org}/{project-name}"]
  16 image:https://img.shields.io/coveralls/{github-org}/{project-name}/master.svg?style=flat-square["Code Coverage", link="https://coveralls.io/github/{github-org}/{project-name}"]
  17 image:https://img.shields.io/coverity/scan/{coverity-project}.svg?style=flat-square["Coverity Scan Result", link="https://scan.coverity.com/projects/{github-org}-{project-name}"]
  18 image:https://img.shields.io/codacy/grade/{codacy-project}.svg?style=flat-square["Codacy Code Quality", link="https://www.codacy.com/app/mail_7/{project-name}"]
  19 link="https://basicallydan.github.io/forkability/?u={github-org}&r={project-name}"]
  20 image:https://img.shields.io/maintenance/yes/2016.svg?style=flat-square["Is this thing still maintained?"]
  21 image:https://img.shields.io/bountysource/team/metio/activity.svg?style=flat-square["Bounties on open tickets", link="https://www.bountysource.com/teams/metio"]
  22
  23 Utility library for null analysis in Java projects.
  24
  25 == Usage
  26
  27 Convert any `@Nullable` reference from legacy code to a `@NonNull` reference by using the `Nullsafe` utility class:
  28
  29 [source, java]
  30 ----
  31 @Nullable Object myObject = ...
  32 @NonNull Object nonNullObject = Nullsafe.nonNull(myObject);
  33 ----
  34
  35 An `IllegalArgumentException` is thrown in case `myObject` is `null`.
  36
  37 === Integration
  38
  39 To use this project just declare the following dependency inside your POM:
  40
  41 [source, xml, subs="attributes,verbatim"]
  42 ----
  43 <dependency>
  44   <groupId>{project-group}</groupId>
  45   <artifactId>{project-name}</artifactId>
  46   <version>${version.null-analysis}</version>
  47 </dependency
  48 ----
  49
  50 Replace `${version.null-analysis}` with the pass:[<a href="http://search.maven.org/#search%7Cga%7C1%7Cg%3Ade.xn--ho-hia.quality%20a%3Anull-analysis">latest release</a>]. This project follows the link:http://semver.org/[semantic versioning guidelines].
  51
  52 === Compatibility
  53
  54 This project is compatible with the following Java versions:
  55
  56 .Java compatibility
  57 |===
  58 | | 3.X.Y
  59
  60 | Java 8
  61 | ✓
  62 |===
  63
  64
  65 == License
  66
  67 To the extent possible under law, the author(s) have dedicated all copyright
  68 and related and neighboring rights to this software to the public domain
  69 worldwide. This software is distributed without any warranty.
  70
  71 You should have received a copy of the CC0 Public Domain Dedication along
  72 with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
  73
  74 == Mirrors
  75
  76 * https://github.com/sebhoss/{project-name}
  77 * https://bitbucket.org/sebhoss/{project-name}
  78 * https://gitlab.com/sebastian.hoss/{project-name}
  79 * http://repo.or.cz/{project-name}.git