ch.jalu.typeresolver.typeimpl

Class ParameterizedTypeBuilder

java.lang.Object

ch.jalu.typeresolver.typeimpl.ParameterizedTypeBuilder

public class ParameterizedTypeBuilder
extends Object

Builder to create parameterized types programmatically.

Example:

   ParameterizedType pt = newTypeFromClass(Optional.class)
     .withTypeArg(0, String.class)
     .build();
  // pt = Optional<String>
 

You can also start with the existing values of a parameterized type using the constructor ParameterizedTypeBuilder(ParameterizedType).

Constructor Summary

Constructors

Constructor and Description
ParameterizedTypeBuilder(ParameterizedType parameterizedType) Creates a builder with the given parameterized type as initial values.

Method Summary

Modifier and Type	Method and Description
ParameterizedTypeImpl	build() Creates a parameterized type with the configured raw type and type arguments.
static @Nullable Type	createOwnerType(Class<?> rawType) Creates the appropriate Type with generic information (if needed) to be used as owner type of a parameterized type impl with the given raw type.
static ParameterizedTypeImpl	newCollectionType(Class<? extends Collection> baseType, @Nullable Type typeArgument) Creates a new parameterized type representing the given Collection type and the provided type argument.
static ParameterizedTypeImpl	newMapType(Class<? extends Map> baseType, @Nullable Type keyType, @Nullable Type valueType) Creates a new parameterized type representing the given Map type and the provided key and value arguments.
static ParameterizedTypeBuilder	parameterizedTypeBuilder(Class<?> clazz) Creates a builder with the given Class as its base type.
ParameterizedTypeBuilder	withTypeArg(int typeParameterIndex, @Nullable Type type) Sets the type parameter at the given index to the provided type.
ParameterizedTypeBuilder	withTypeArg(int typeParameterIndex, TypeInfo typeInfo) Sets the type argument to the given index.
ParameterizedTypeBuilder	withTypeArg(String typeParameterName, @Nullable Type type) Sets the type parameter with the given name to the provided type.
ParameterizedTypeBuilder	withTypeArg(String typeParameterName, TypeInfo typeInfo) Sets the type argument for the parameter with the given name.
ParameterizedTypeBuilder	withTypeArg(TypeVariable<?> typeVariable, @Nullable Type type) Sets the type parameter identified by the given type variable to the provided type.
ParameterizedTypeBuilder	withTypeArg(TypeVariable<?> typeVariable, TypeInfo typeInfo) Sets the given type variable to the provided type.
ParameterizedTypeBuilder	withTypeVariables() Resets all type parameters to the type variables of the raw type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterizedTypeBuilder

public ParameterizedTypeBuilder(ParameterizedType parameterizedType)

Creates a builder with the given parameterized type as initial values.

Parameters:

parameterizedType - the parameterized type to start the builder off with

Method Detail

parameterizedTypeBuilder

public static ParameterizedTypeBuilder parameterizedTypeBuilder(Class<?> clazz)

Creates a builder with the given Class as its base type.

Parameters:

clazz - the raw type of the parameterized type that will be created

Returns:

new builder with the given class as the raw type

Throws:

IllegalArgumentException - if the class has no type parameters

newCollectionType

public static ParameterizedTypeImpl newCollectionType(Class<? extends Collection> baseType,
                                                      @Nullable
                                                      @Nullable Type typeArgument)

Creates a new parameterized type representing the given Collection type and the provided type argument. Throws an exception if the given base type does not have at least one type parameter.

Example:

 newCollectionType(ArrayList.class, Double.class) // ArrayList<Double>

If you know the base type and argument at compile time, consider using TypeReference instead:
Type type = new TypeReference<ArrayList<String>>(){ }.getType().

Parameters:

baseType - the collection type to use as raw type

typeArgument - the type argument of the collection

Returns:

parameterized type

Throws:

IllegalArgumentException - if the base type does not have at least one type parameter

newMapType

public static ParameterizedTypeImpl newMapType(Class<? extends Map> baseType,
                                               @Nullable
                                               @Nullable Type keyType,
                                               @Nullable
                                               @Nullable Type valueType)

Creates a new parameterized type representing the given Map type and the provided key and value arguments. Throws an exception if the given map type does not have at least two type parameters.

Example:

 newMapType(HashMap.class, String.class, Double.class) // Map<String, Double>

If you know the base type and arguments at compile time, consider using TypeReference instead:
Type type = new TypeReference<HashMap<String, Double>>(){ }.getType().

Parameters:

baseType - the map implementation type to use as raw type

keyType - the key type argument

valueType - the value type argument

Returns:

parameterized type

Throws:

IllegalArgumentException - if the base type does not have at least two type parameters

withTypeArg

public ParameterizedTypeBuilder withTypeArg(int typeParameterIndex,
                                            TypeInfo typeInfo)

Sets the type argument to the given index. Equivalent to withTypeArg(int, Type).

Parameters:

typeParameterIndex - the index of the parameter to set (0-based)

typeInfo - type info whose type should be set as argument

Returns:

this builder

withTypeArg

public ParameterizedTypeBuilder withTypeArg(int typeParameterIndex,
                                            @Nullable
                                            @Nullable Type type)

Sets the type parameter at the given index to the provided type. Null can be provided to reset the type parameter at the given index back to the class's type variable. Throws an exception if the parameter index is invalid.

Example:

 newTypeFromClass(Optional.class).withTypeArg(0, Double.class).build();

Parameters:

typeParameterIndex - the index of the parameter to set (0-based)

type - the type to set (or null to reset to the type variable)

Returns:

this builder

Throws:

IllegalArgumentException - if the type parameter index is out of bounds

withTypeArg

public ParameterizedTypeBuilder withTypeArg(String typeParameterName,
                                            TypeInfo typeInfo)

Sets the type argument for the parameter with the given name. Equivalent to withTypeArg(int, Type).

Parameters:

typeParameterName - the name of the type parameter to set

typeInfo - type info whose type should be set as argument

Returns:

this builder

Throws:

IllegalArgumentException - if the raw type does not have a type parameter matching the name

withTypeArg

public ParameterizedTypeBuilder withTypeArg(String typeParameterName,
                                            @Nullable
                                            @Nullable Type type)

Sets the type parameter with the given name to the provided type. Null can be provided to reset the type parameter back to the class's type variable. Throws an exception if the parameter name could not be found.

Example:

 newTypeFromClass(Optional.class).withTypeArg("T", Double.class).build();

Parameters:

typeParameterName - the name of the type parameter to set

type - the type to set (or null to reset to the type variable)

Returns:

this builder

Throws:

IllegalArgumentException - if the raw type does not have a type parameter matching the name

withTypeArg

public ParameterizedTypeBuilder withTypeArg(TypeVariable<?> typeVariable,
                                            TypeInfo typeInfo)

Sets the given type variable to the provided type. Equivalent to withTypeArg(TypeVariable, Type).

Parameters:

typeVariable - the type variable to match

typeInfo - type info whose type should be set as argument

Returns:

this builder

Throws:

IllegalArgumentException - if the type variable does not belong to the raw type

withTypeArg

public ParameterizedTypeBuilder withTypeArg(TypeVariable<?> typeVariable,
                                            @Nullable
                                            @Nullable Type type)

Sets the type parameter identified by the given type variable to the provided type. Null can be provided to reset the type parameter back to the class's type variable. Throws an exception if the type variable could not be matched.

Example:

    TypeVariable<?> tv = Optional.class.getTypeParameters()[0];
    newTypeFromClass(Optional.class).withTypeArg(tv, Integer.class);
 

Parameters:

typeVariable - the type variable to match

type - the type to set (or null to reset to the type variable)

Returns:

this builder

Throws:

IllegalArgumentException - if the type variable does not belong to the raw type

withTypeVariables

public ParameterizedTypeBuilder withTypeVariables()

Resets all type parameters to the type variables of the raw type.

Returns:

this builder

build

public ParameterizedTypeImpl build()

Creates a parameterized type with the configured raw type and type arguments. An exception is thrown if any type argument is missing.

Returns:

new parameterized type

Throws:

IllegalStateException - if a type parameter has not been associated with a value

createOwnerType

@Nullable
public static @Nullable Type createOwnerType(Class<?> rawType)

Creates the appropriate Type with generic information (if needed) to be used as owner type of a parameterized type impl with the given raw type.

Parameters:

rawType - the raw type whose owner type should be created with generic information

Returns:

owner type to use for the raw type