org.microbean.configuration.api

Class TypeLiteral<T>

java.lang.Object

org.microbean.configuration.api.TypeLiteral<T>

Type Parameters:

T - the type being represented

All Implemented Interfaces:

Serializable

public abstract class TypeLiteral<T>
extends Object
implements Serializable

A class that can represent generic types.

Author:

Laird Nelson

See Also:

Type, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypeLiteral() Creates a new TypeLiteral.
protected	TypeLiteral(Class<T> classHierarchyParent) Creates a new TypeLiteral with a deeper class hierarchy.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Returns true if the supplied Object is equal to this TypeLiteral.
Type	getType() Returns the Type represented by this TypeLiteral.
int	hashCode() Returns a hashcode for this TypeLiteral based off its Type's hashcode.
String	toString() Returns a non-null String representation of this TypeLiteral.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypeLiteral

protected TypeLiteral()

Creates a new TypeLiteral.

TypeLiteral

protected TypeLiteral(Class<T> classHierarchyParent)

Creates a new TypeLiteral with a deeper class hierarchy.

This specialized constructor is for use only by abstract subclasses of TypeLiteral that are extending and looking to use the subsequently extended type inspection capabilities of this class.

Type Parameters:

T - a type representing a subclass of TypeLiteral

Parameters:

classHierarchyParent - the first class beneath this class in the subclass hierarchy whose immediate subclasses will be inspected for parameterized type information; must not be null

Throws:

NullPointerException - if classHierarchyParent is null

Method Detail

getType

public final Type getType()

Returns the Type represented by this TypeLiteral.

This method never returns null.

Returns:

the Type represented by this TypeLiteral; never null

Throws:

IllegalStateException - if somehow this TypeLiteral was instantiated without a type parameter

hashCode

public int hashCode()

Returns a hashcode for this TypeLiteral based off its Type's hashcode.

Overrides:

hashCode in class Object

Returns:

a hashcode for this TypeLiteral

See Also:

equals(Object)

equals

public boolean equals(Object other)

Returns true if the supplied Object is equal to this TypeLiteral.

Two TypeLiteral instances are equal if their getType() methods' return values are equal.

Overrides:

equals in class Object

Parameters:

other - the Object to test; may be null

Returns:

true if the supplied Object is equal to this TypeLiteral; false otherwise

See Also:

hashCode()

toString

public String toString()

Returns a non-null String representation of this TypeLiteral.

This method never returns null.

Overrides of this method must not return null.

Overrides:

toString in class Object

Returns:

a non-null String representation of this TypeLiteral