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
   8 image:https://img.shields.io/badge/license-cc%20zero-000000.svg?style=flat-square["CC Zero", link="http://creativecommons.org/publicdomain/zero/1.0/"]
   9 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>]
  10 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>]
  11 image:https://www.openhub.net/p/{project-name}/widgets/project_thin_badge.gif["Open Hub statistics", link="https://www.openhub.net/p/{project-name}"]
  12 image:https://reposs.herokuapp.com/?path={github-org}/{project-name}&style=flat-square["Repository size"]
  13
  14 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}"]
  15 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}"]
  16 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}"]
  17
  18 Utility library for null analysis in Java projects.
  19
  20 == Usage
  21
  22 Convert any `@Nullable` reference from legacy code to a `@NonNull` reference by using the `Nullsafe` utility class:
  23
  24 [source, java]
  25 ----
  26 @Nullable Object myObject = ...
  27 @NonNull Object nonNullObject = Nullsafe.nonNull(myObject);
  28 ----
  29
  30 An `IllegalArgumentException` is thrown in case `myObject` is `null`.
  31
  32 === Integration
  33
  34 To use this project just declare the following dependency inside your POM:
  35
  36 [source, xml, subs="attributes,verbatim"]
  37 ----
  38 <dependency>
  39   <groupId>{project-group}</groupId>
  40   <artifactId>{project-name}</artifactId>
  41   <version>${version.null-analysis}</version>
  42 </dependency
  43 ----
  44
  45 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].
  46
  47 === Compatibility
  48
  49 This project is compatible with the following Java versions:
  50
  51 .Java compatibility
  52 |===
  53 | | 3.X.Y
  54
  55 | Java 8
  56 | ✓
  57 |===
  58
  59
  60 == License
  61
  62 To the extent possible under law, the author(s) have dedicated all copyright
  63 and related and neighboring rights to this software to the public domain
  64 worldwide. This software is distributed without any warranty.
  65
  66 You should have received a copy of the CC0 Public Domain Dedication along
  67 with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
  68
  69 == Mirrors
  70
  71 * https://github.com/sebhoss/{project-name}
  72 * https://bitbucket.org/sebhoss/{project-name}
  73 * https://gitlab.com/sebastian.hoss/{project-name}
  74 * http://repo.or.cz/{project-name}.git