ru.vyarus.java.generics.resolver.context

Class GenericsInfo

java.lang.Object

ru.vyarus.java.generics.resolver.context.GenericsInfo

public class GenericsInfo
extends java.lang.Object

Holds types hierarchy resolved generics information. Contains not just types actually containing generics, but all types (so type without generics will reference empty map). This was done for simplicity: all types from hierarchy are known and reference generics context is completely safe for all types from hierarchy.

Maps also may hold outer type's generics (if type is inner class), because inner classes could access outer generics (GenericsContext for separation logic).

Since:

16.10.2014

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericsInfo.DefaultTypeWriter Default hierarchy writer implementation.
static interface	GenericsInfo.TypeWriter Customization interface to control types hierarchy to string behaviour.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SHIFT_MARKER Single shift marker used to identity hierarchy level for toString.

Constructor Summary

Constructors

Constructor and Description
GenericsInfo(java.lang.Class<?> root, java.util.Map<java.lang.Class<?>,java.util.LinkedHashMap<java.lang.String,java.lang.reflect.Type>> types, java.lang.Class... ignoredTypes)

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	findContextByDeclarationType(java.lang.Class<?> declarationType) Search class in current hierarchy, containing declaration type.
java.util.Set<java.lang.Class<?>>	getComposingTypes()
java.lang.Class[]	getIgnoredTypes()
java.lang.Class<?>	getRootClass()
java.util.Map<java.lang.String,java.lang.reflect.Type>	getTypeGenerics(java.lang.Class<?> type)
java.util.Map<java.lang.Class<?>,java.util.LinkedHashMap<java.lang.String,java.lang.reflect.Type>>	getTypesMap()
java.lang.String	toString()
java.lang.String	toStringHierarchy(GenericsInfo.TypeWriter typeWriter) Write current root class hierarchy with resolved generics.

Methods inherited from class java.lang.Object

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

Field Detail

SHIFT_MARKER

public static final java.lang.String SHIFT_MARKER

Single shift marker used to identity hierarchy level for toString.

See Also:

Constant Field Values

Constructor Detail

GenericsInfo

public GenericsInfo(java.lang.Class<?> root,
                    java.util.Map<java.lang.Class<?>,java.util.LinkedHashMap<java.lang.String,java.lang.reflect.Type>> types,
                    java.lang.Class... ignoredTypes)

Method Detail

getRootClass

public java.lang.Class<?> getRootClass()

Returns:

root class (from where generics resolution started)

getTypeGenerics

public java.util.Map<java.lang.String,java.lang.reflect.Type> getTypeGenerics(java.lang.Class<?> type)

Parameters:

type - class to get generics for

Returns:

map of resolved generics for class (base class or interface implemented by root class or nay subclass)

Throws:

java.lang.IllegalArgumentException - is requested class is not present in root class hierarchy

getComposingTypes

public java.util.Set<java.lang.Class<?>> getComposingTypes()

Returns:

list of all classes (and interfaces) of root class hierarchy

getIgnoredTypes

public java.lang.Class[] getIgnoredTypes()

Returns:

types ignored from analysis (all specified types to ignore)

getTypesMap

public java.util.Map<java.lang.Class<?>,java.util.LinkedHashMap<java.lang.String,java.lang.reflect.Type>> getTypesMap()

Returns:

all known types in hierarchy with known generics

findContextByDeclarationType

public java.lang.Class<?> findContextByDeclarationType(java.lang.Class<?> declarationType)

Search class in current hierarchy, containing declaration type. Used to find appropriate context when generic could be correctly resolved (knowing generic declaration type).

There are to situations: either class is directly in hierarchy or it is outer class for some class in hierarchy (in this case inner class is correct context).

Parameters:

declarationType - generic declaration class

Returns:

required context class or null if impossible to resolve in current hierarchy

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

current hierarchy with resolved generics

See Also:

for customized output

toStringHierarchy

public java.lang.String toStringHierarchy(GenericsInfo.TypeWriter typeWriter)

Write current root class hierarchy with resolved generics. Use custom writer to modify type rendering (on each line).

Parameters:

typeWriter - custom type writer

Returns:

current hierarchy with resolved generics