README.asciidoc

   1 = Generic Types 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: generic-types
   5 :project-group: de.xn--ho-hia.utils.types
   6 :coverity-project: 7620
   7 :codacy-project: 9402c820df454d3a83c697f254aeb1b3
   8 :toc:
   9 :toc-placement: preamble
  10
  11 image:https://img.shields.io/badge/license-cc%20zero-000000.svg?style=flat-square["CC Zero", link="http://creativecommons.org/publicdomain/zero/1.0/"]
  12 pass:[<span class="image"><a class="image" href="https://maven-badges.herokuapp.com/maven-central/de.xn--ho-hia.utils.types/generic-types"><img src="https://img.shields.io/maven-central/v/de.xn--ho-hia.utils.types/generic-types.svg?style=flat-square" alt="Maven Central"></a></span>]
  13 pass:[<span class="image"><a class="image" href="https://www.javadoc.io/doc/de.xn--ho-hia.utils.types/generic-types"><img src="https://www.javadoc.io/badge/de.xn--ho-hia.utils.types/generic-types.svg?style=flat-square&color=blue" alt="Read JavaDocs"></a></span>]
  14 image:https://www.openhub.net/p/{project-name}/widgets/project_thin_badge.gif["Open Hub statistics", link="https://www.ohloh.net/p/{project-name}"]
  15
  16 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}"]
  17 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}"]
  18 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}"]
  19 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}"]
  20
  21 This https://www.java.com[Java] library provides a factory to create generic `java.lang.reflect.Type` variations, such as `Map<Number, Point>`.
  22
  23 === Features
  24
  25 * Factory methods to create generic types, including wildcards.
  26
  27 === Development Status
  28
  29 All currently required feature are implemented. This project is in maintenance mode.
  30
  31
  32 == Usage
  33
  34 [source,java]
  35 ----
  36 // Map<Number, Point>
  37 final Type type = GenericTypes.generic(Map.class, Number.class, Point.class);
  38
  39 // List<Number>
  40 final Type type = GenericTypes.generic(List.class, Number.class);
  41 ----
  42
  43 Super- and subtypes such as `List<? super Point>` or `List<? extends Number>` can be created in the following way:
  44
  45 [source,java]
  46 ----
  47 // List<? super Point>
  48 final Type type = GenericTypes.generic(List.class, GenericTypes.supertype(Point.class));
  49
  50 // List<? extends Number>
  51 final Type type = GenericTypes.generic(List.class, GenericTypes.subtype(Number.class));
  52 ----
  53
  54 Use static imports to shorten the above calls to:
  55
  56 [source,java]
  57 ----
  58 // List<? super Point>
  59 final Type type = generic(List.class, supertype(Point.class));
  60
  61 // List<? extends Number>
  62 final Type type = generic(List.class, subtype(Number.class));
  63 ----
  64
  65 and then go crazy with this:
  66
  67 [source,java]
  68 ----
  69 // List<Map<? extends Number, ? super Point>>
  70 final Type type = generic(List.class, generic(Map.class, subtype(Number.class), supertype(Point.class)));
  71 ----
  72
  73 === Integration
  74
  75 To use this project just declare the following dependency inside your POM:
  76
  77 [source,xml,subs="attributes,verbatim"]
  78 ----
  79 <dependencies>
  80   <dependency>
  81     <groupId>{project-group}</groupId>
  82     <artifactId>{project-name}</artifactId>
  83     <version>${version.generic-types}</version>
  84   </dependency>
  85 </dependencies>
  86 ----
  87
  88 Replace `${version.generic-types}` with the pass:[<a href="http://search.maven.org/#search%7Cga%7C1%7Cg%3Ade.xn--ho-hia.utils.types%20a%3Ageneric-types">latest release</a>]. This project follows the link:http://semver.org/[semantic versioning guidelines].
  89
  90
  91 === Compatibility
  92
  93 This project is compatible with the following Java versions:
  94
  95 .Java compatibility
  96 |===
  97 | | 1.X.Y | 2.X.Y
  98
  99 | Java 8
 100 | ✓
 101 | ✓
 102 |===
 103
 104 == License
 105
 106 To the extent possible under law, the author(s) have dedicated all copyright
 107 and related and neighboring rights to this software to the public domain
 108 worldwide. This software is distributed without any warranty.
 109
 110 You should have received a copy of the CC0 Public Domain Dedication along
 111 with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.