README.asciidoc

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