|
| 1 | +/* |
| 2 | + * #%L |
| 3 | + * SciJava Operations: a framework for reusable algorithms. |
| 4 | + * %% |
| 5 | + * Copyright (C) 2016 - 2019 SciJava Ops developers. |
| 6 | + * %% |
| 7 | + * Redistribution and use in source and binary forms, with or without |
| 8 | + * modification, are permitted provided that the following conditions are met: |
| 9 | + * |
| 10 | + * 1. Redistributions of source code must retain the above copyright notice, |
| 11 | + * this list of conditions and the following disclaimer. |
| 12 | + * 2. Redistributions in binary form must reproduce the above copyright notice, |
| 13 | + * this list of conditions and the following disclaimer in the documentation |
| 14 | + * and/or other materials provided with the distribution. |
| 15 | + * |
| 16 | + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 17 | + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 18 | + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 19 | + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE |
| 20 | + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 21 | + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 22 | + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 23 | + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 24 | + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 25 | + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 26 | + * POSSIBILITY OF SUCH DAMAGE. |
| 27 | + * #L% |
| 28 | + */ |
| 29 | + |
| 30 | +/** |
| 31 | + * This package provides extended support for reasoning about generic types at |
| 32 | + * runtime, beyond what is offered by SciJava Common's |
| 33 | + * {@link org.scijava.util.Types} class. This package offers the following |
| 34 | + * additional features: |
| 35 | + * <ul> |
| 36 | + * <li>Reason about whether a collection of arguments (object instances, generic |
| 37 | + * types, or a mixture thereof) satisfy a given list of generic types, such as |
| 38 | + * those of a particular method signature. See |
| 39 | + * {@link org.scijava.ops.types.TypeTools#satisfies} for details.</li> |
| 40 | + * <li>Create {@link org.scijava.ops.types.Nil} objects, which act as "typed |
| 41 | + * null" placeholders, and support generation of proxy instances of their |
| 42 | + * associated generic type, similar to (but less featureful than) how mocking |
| 43 | + * frameworks create mock objects.</li> |
| 44 | + * <li>Recover erased generic type information from object instances at runtime, |
| 45 | + * in an extensible way, via {@link org.scijava.ops.types.TypeExtractor} plugins |
| 46 | + * and the {@link TypeService#reify} method. E.g., you can learn that an object |
| 47 | + * of class {@link java.util.HashMap} is actually (or at least functionally) a |
| 48 | + * {@code HashMap<String, Integer>}.</li> |
| 49 | + * </ul> |
| 50 | + */ |
| 51 | + |
| 52 | +package org.scijava.ops.types; |
0 commit comments