AbstractTypesContract (Java Types 1.0.1 Test API)

java.lang.Object
- net.florianschoppmann.java.type.AbstractTypesContract

All Implemented Interfaces:

org.testng.ITest
```
public final class AbstractTypesContract
extends Object
implements org.testng.ITest
```
Contract test for AbstractTypes.
This class should be instantiated and returned by a TestNG factory method (that is, a method annotated with Factory).

Constructor Summary

Constructors
Constructor and Description

AbstractTypesContract(AbstractTypesProvider provider)
Constructs a new contract-test instance with the given provider.

Constructors
Constructor and Description
`AbstractTypesContract(AbstractTypesProvider provider)` Constructs a new contract-test instance with the given provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`asElement()` Verifies `AbstractTypes.asElement(TypeMirror)`.
`void`	`asElementInvalidArguments()` Verifies that `AbstractTypes.asElement(TypeMirror)` throws expected exceptions.
`void`	`asType()` Verifies `Element.asType()`.
`void`	`boxedClass()` Verifies that `Types.boxedClass(PrimitiveType)` throws expected exceptions.
`void`	`boxingAndUnboxing()` Verifies that `Types.unboxedType(TypeMirror)` and `Types.boxedClass(PrimitiveType)` are (essentially) inverse methods of each other.
`void`	`capture()` Verifies `AbstractTypes.capture(TypeMirror)`.
`void`	`captureInterdependentRecursiveBound()`
`void`	`captureSingleRecursiveBound()`
`void`	`createTypeVariable()` Verifies `AbstractTypes.createTypeVariable(TypeParameterElement, WildcardType)`.
`String`	`getTestName()`
`void`	`requireValidElement()` Verifies that `AbstractTypes.requireValidElement(javax.lang.model.element.Element)` throws a `NullPointerException` if passed null.
`void`	`requireValidType()` Verifies that `AbstractTypes.requireValidType(TypeMirror)` does not throw an exception if passed null.
`void`	`requireValidTypes()` Verifies that `AbstractTypes.requireValidTypes(TypeMirror[])` throws exceptions if passed null or an array with null element.
`void`	`resolveActualTypeArguments()` Verifies `AbstractTypes.resolveActualTypeArguments(TypeElement, TypeMirror)` when the second argument is a generic type, a non-generic type, or a primitive type.
`void`	`resolveActualTypeArgumentsArrays()` Verifies `AbstractTypes.resolveActualTypeArguments(TypeElement, TypeMirror)` if the second argument contains an actual type argument that is an array type.
`void`	`resolveActualTypeArgumentsRaw()` Verifies `AbstractTypes.resolveActualTypeArguments(TypeElement, TypeMirror)` if the second argument is a raw type.
`void`	`setup()` Performs initialization steps necessary in order to run the contract tests subsequently.
`void`	`substitute()` Verifies `AbstractTypes.substitute(TypeMirror, Map)`.
`void`	`testContains()` Verifies `AbstractTypes.contains(TypeMirror, TypeMirror)`.
`void`	`testContainsInvalidArguments()` Verifies that `AbstractTypes.contains(TypeMirror, TypeMirror)` throws expected exceptions.
`void`	`testEqualsAndHashCode()`
`void`	`testErasure()` Verifies `AbstractTypes.erasure(TypeMirror)`.
`void`	`testErasureInvalidArguments()` Verifies that `AbstractTypes.erasure(TypeMirror)` throws expected exceptions.
`void`	`testGetIntersectionType()`
`void`	`testGetNoType()`
`void`	`testGetNullType()`
`void`	`testGetPrimitiveType()` Verifies that `Types.getPrimitiveType(TypeKind)` throws expected exceptions.
`void`	`testGetTypeVariable()` Verifies `AbstractTypes.getTypeVariable(TypeParameterElement, TypeMirror, TypeMirror, WildcardType)`.
`void`	`testIsSameType()` Verifies `AbstractTypes.isSameType(TypeMirror, TypeMirror)`.
`void`	`testIsSameTypeInvalidArguments()` Verifies that `AbstractTypes.isSameType(TypeMirror, TypeMirror)` throws expected exceptions.
`void`	`testIsSubtypeArray()` Verifies `AbstractTypes.isSubtype(TypeMirror, TypeMirror)` if one of the types is an array type.
`void`	`testIsSubtypeArrayTypeParameters()`
`void`	`testIsSubtypeIntersection()` Verifies `AbstractTypes.isSubtype(TypeMirror, TypeMirror)` if one of the types is an intersection type.
`void`	`testIsSubtypeNull()` Verifies `AbstractTypes.isSubtype(TypeMirror, TypeMirror)` if one of the types is the null type.
`void`	`testIsSubtypePrimitive()` Verifies `AbstractTypes.isSubtype(TypeMirror, TypeMirror)` if one of the types is a primitive type.
`void`	`testIsSubtypeRaw()` Verifies `AbstractTypes.isSubtype(TypeMirror, TypeMirror)` if one of the types is a raw type.
`void`	`testIsSubtypeSimpleTypeParameters()`
`void`	`testIsSubtypeWildcards()`
`void`	`testSetTypeVariableBounds()` Verifies `AbstractTypes.setTypeVariableBounds(TypeVariable, TypeMirror, TypeMirror)`.
`void`	`testSetup()` Verifies the `TypeElement` instances in `typeElementMap`.
`void`	`testToString()`
`void`	`typeElementTest()`
`void`	`typeMirror()` Verifies `AbstractTypes.typeMirror(java.lang.reflect.Type)`.
`void`	`typeParameterElementTest()`
`void`	`unboxedType()` Verifies that `Types.unboxedType(TypeMirror)` throws expected exceptions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractTypesContract
```
public AbstractTypesContract(AbstractTypesProvider provider)
```
    Constructs a new contract-test instance with the given provider.
    
    Parameters:
    
    provider - provider of AbstractTypes instance, must not be null
    
    Throws:
    
    NullPointerException - if the argument is null
- Method Detail
  - getTestName
```
public String getTestName()
```
    Specified by:
    
    getTestName in interface org.testng.ITest
  - setup
```
public void setup()
```
    Performs initialization steps necessary in order to run the contract tests subsequently.
  - testSetup
```
public void testSetup()
```
    Verifies the TypeElement instances in typeElementMap.
    The following is verified:
    - Element.asType() returns "a prototypical type" which is "the element's invocation on the type variables corresponding to its own formal type parameters".
    - type(Class) returns a raw type if the given class object represents a generic type declaration.
    - Passing the raw type returned by type(Class) to AbstractTypes.toString(TypeMirror) yields a string equal to the class's name.
  - requireValidElement
```
public void requireValidElement()
```
    Verifies that AbstractTypes.requireValidElement(javax.lang.model.element.Element) throws a NullPointerException if passed null.
  - requireValidType
```
public void requireValidType()
```
    Verifies that AbstractTypes.requireValidType(TypeMirror) does not throw an exception if passed null.
  - requireValidTypes
```
public void requireValidTypes()
```
    Verifies that AbstractTypes.requireValidTypes(TypeMirror[]) throws exceptions if passed null or an array with null element.
  - typeMirror
```
public void typeMirror()
```
    Verifies AbstractTypes.typeMirror(java.lang.reflect.Type).
  - substitute
```
public void substitute()
```
    Verifies AbstractTypes.substitute(TypeMirror, Map).
  - resolveActualTypeArguments
```
public void resolveActualTypeArguments()
```
    Verifies AbstractTypes.resolveActualTypeArguments(TypeElement, TypeMirror) when the second argument is a generic type, a non-generic type, or a primitive type.
  - resolveActualTypeArgumentsRaw
```
public void resolveActualTypeArgumentsRaw()
```
    Verifies AbstractTypes.resolveActualTypeArguments(TypeElement, TypeMirror) if the second argument is a raw type.
  - resolveActualTypeArgumentsArrays
```
public void resolveActualTypeArgumentsArrays()
```
    Verifies AbstractTypes.resolveActualTypeArguments(TypeElement, TypeMirror) if the second argument contains an actual type argument that is an array type.
  - testIsSubtypePrimitive
```
public void testIsSubtypePrimitive()
```
    Verifies AbstractTypes.isSubtype(TypeMirror, TypeMirror) if one of the types is a primitive type.
  - testIsSubtypeNull
```
public void testIsSubtypeNull()
```
    Verifies AbstractTypes.isSubtype(TypeMirror, TypeMirror) if one of the types is the null type.
  - testIsSubtypeArray
```
public void testIsSubtypeArray()
```
    Verifies AbstractTypes.isSubtype(TypeMirror, TypeMirror) if one of the types is an array type.
  - testIsSubtypeIntersection
```
public void testIsSubtypeIntersection()
```
    Verifies AbstractTypes.isSubtype(TypeMirror, TypeMirror) if one of the types is an intersection type.
  - testIsSubtypeRaw
```
public void testIsSubtypeRaw()
```
    Verifies AbstractTypes.isSubtype(TypeMirror, TypeMirror) if one of the types is a raw type.
  - testIsSubtypeArrayTypeParameters
```
public void testIsSubtypeArrayTypeParameters()
```
  - testIsSubtypeSimpleTypeParameters
```
public void testIsSubtypeSimpleTypeParameters()
```
  - testIsSubtypeWildcards
```
public void testIsSubtypeWildcards()
```
  - capture
```
public void capture()
```
    Verifies AbstractTypes.capture(TypeMirror).
  - captureSingleRecursiveBound
```
public void captureSingleRecursiveBound()
```
  - captureInterdependentRecursiveBound
```
public void captureInterdependentRecursiveBound()
```
  - testContainsInvalidArguments
```
public void testContainsInvalidArguments()
```
    Verifies that AbstractTypes.contains(TypeMirror, TypeMirror) throws expected exceptions.
  - testContains
```
public void testContains()
```
    Verifies AbstractTypes.contains(TypeMirror, TypeMirror).
  - testErasureInvalidArguments
```
public void testErasureInvalidArguments()
```
    Verifies that AbstractTypes.erasure(TypeMirror) throws expected exceptions.
  - testErasure
```
public void testErasure()
```
    Verifies AbstractTypes.erasure(TypeMirror).
  - asElementInvalidArguments
```
public void asElementInvalidArguments()
```
    Verifies that AbstractTypes.asElement(TypeMirror) throws expected exceptions.
  - asElement
```
public void asElement()
```
    Verifies AbstractTypes.asElement(TypeMirror).
  - asType
```
public void asType()
```
    Verifies Element.asType().
  - testIsSameTypeInvalidArguments
```
public void testIsSameTypeInvalidArguments()
```
    Verifies that AbstractTypes.isSameType(TypeMirror, TypeMirror) throws expected exceptions.
  - testIsSameType
```
public void testIsSameType()
```
    Verifies AbstractTypes.isSameType(TypeMirror, TypeMirror).
  - testGetTypeVariable
```
public void testGetTypeVariable()
```
    Verifies AbstractTypes.getTypeVariable(TypeParameterElement, TypeMirror, TypeMirror, WildcardType).
  - createTypeVariable
```
public void createTypeVariable()
```
    Verifies AbstractTypes.createTypeVariable(TypeParameterElement, WildcardType).
  - testSetTypeVariableBounds
```
public void testSetTypeVariableBounds()
```
    Verifies AbstractTypes.setTypeVariableBounds(TypeVariable, TypeMirror, TypeMirror).
  - testGetIntersectionType
```
public void testGetIntersectionType()
```
  - testToString
```
public void testToString()
```
  - unboxedType
```
public void unboxedType()
```
    Verifies that Types.unboxedType(TypeMirror) throws expected exceptions.
  - boxedClass
```
public void boxedClass()
```
    Verifies that Types.boxedClass(PrimitiveType) throws expected exceptions.
  - boxingAndUnboxing
```
public void boxingAndUnboxing()
```
    Verifies that Types.unboxedType(TypeMirror) and Types.boxedClass(PrimitiveType) are (essentially) inverse methods of each other.
  - testGetPrimitiveType
```
public void testGetPrimitiveType()
```
    Verifies that Types.getPrimitiveType(TypeKind) throws expected exceptions.
  - testGetNoType
```
public void testGetNoType()
```
  - testGetNullType
```
public void testGetNullType()
```
  - testEqualsAndHashCode
```
public void testEqualsAndHashCode()
```
  - typeElementTest
```
public void typeElementTest()
```
  - typeParameterElementTest
```
public void typeParameterElementTest()
```

Class AbstractTypesContract

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractTypesContract

Method Detail

getTestName

setup

testSetup

requireValidElement

requireValidType

requireValidTypes

typeMirror

substitute

resolveActualTypeArguments

resolveActualTypeArgumentsRaw

resolveActualTypeArgumentsArrays

testIsSubtypePrimitive

testIsSubtypeNull

testIsSubtypeArray

testIsSubtypeIntersection

testIsSubtypeRaw

testIsSubtypeArrayTypeParameters

testIsSubtypeSimpleTypeParameters

testIsSubtypeWildcards

capture

captureSingleRecursiveBound

captureInterdependentRecursiveBound

testContainsInvalidArguments

testContains

testErasureInvalidArguments

testErasure

asElementInvalidArguments

asElement

asType

testIsSameTypeInvalidArguments

testIsSameType

testGetTypeVariable

createTypeVariable

testSetTypeVariableBounds

testGetIntersectionType

testToString

unboxedType

boxedClass

boxingAndUnboxing

testGetPrimitiveType

testGetNoType

testGetNullType

testEqualsAndHashCode

typeElementTest

typeParameterElementTest