org.fulib.yaml

Class ReflectorMap

java.lang.Object

org.fulib.yaml.ReflectorMap

public class ReflectorMap
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReflectorMap(java.util.ArrayList<java.lang.String> packageNames) Deprecated. since 1.2; use ReflectorMap(Collection) instead
ReflectorMap(java.util.Collection<java.lang.String> packageNames)
ReflectorMap(java.lang.String... packageNames)
ReflectorMap(java.lang.String packageName)

Method Summary

Modifier and Type	Method and Description
boolean	canReflect(java.lang.Class<?> type)
boolean	canReflect(java.lang.Object object)
boolean	canReflect(java.lang.Package thePackage)
java.util.Set<java.lang.Object>	discoverObjects(java.util.Collection<?> roots) Discovers all objects reachable from the roots and within the packages specified in the constructor.
void	discoverObjects(java.util.Collection<?> roots, java.util.Set<java.lang.Object> out) Discovers all objects reachable from the roots and within the packages specified in the constructor.
java.util.Set<java.lang.Object>	discoverObjects(java.lang.Object... roots) Discovers all objects reachable from the roots and within the packages specified in the constructor.
java.util.Set<java.lang.Object>	discoverObjects(java.lang.Object root) Discovers all objects reachable from the root and within the packages specified in the constructor.
void	discoverObjects(java.lang.Object[] roots, java.util.Set<java.lang.Object> out) Discovers all objects reachable from the roots and within the packages specified in the constructor.
void	discoverObjects(java.lang.Object root, java.util.Set<java.lang.Object> out) Discovers all objects reachable from the root and within the packages specified in the constructor.
Reflector	getReflector(java.lang.Class<?> clazz)
Reflector	getReflector(java.lang.Object object)
Reflector	getReflector(java.lang.String simpleName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectorMap

public ReflectorMap(java.lang.String packageName)

Parameters:

packageName - the package name to search for classes

ReflectorMap

public ReflectorMap(java.lang.String... packageNames)

Parameters:

packageNames - the package names to search for classes

Since:

1.2

ReflectorMap

public ReflectorMap(java.util.Collection<java.lang.String> packageNames)

Parameters:

packageNames - the package names to search for classes

Since:

1.2

ReflectorMap

@Deprecated
public ReflectorMap(java.util.ArrayList<java.lang.String> packageNames)

Deprecated. since 1.2; use ReflectorMap(Collection) instead

Parameters:

packageNames - the package names to search for classes

Method Detail

discoverObjects

public java.util.Set<java.lang.Object> discoverObjects(java.lang.Object root)

Discovers all objects reachable from the root and within the packages specified in the constructor. Objects that cannot be handled are neither added to the result nor recursively scanned.

Parameters:

root - the root object

Returns:

the set of all discovered objects

Since:

1.2

discoverObjects

public java.util.Set<java.lang.Object> discoverObjects(java.lang.Object... roots)

Discovers all objects reachable from the roots and within the packages specified in the constructor. Objects that cannot be handled are neither added to the result nor recursively scanned.

Parameters:

roots - the root objects

Returns:

the set of all discovered objects

Since:

1.2

discoverObjects

public java.util.Set<java.lang.Object> discoverObjects(java.util.Collection<?> roots)

Discovers all objects reachable from the roots and within the packages specified in the constructor. Objects that cannot be handled are neither added to the result nor recursively scanned.

Parameters:

roots - the root objects

Returns:

the set of all discovered objects

Since:

1.2

discoverObjects

public void discoverObjects(java.lang.Object root,
                            java.util.Set<java.lang.Object> out)

Discovers all objects reachable from the root and within the packages specified in the constructor. Objects that cannot be handled are neither added to the result nor recursively scanned.

Parameters:

root - the root object

out - the set to which results are added

Since:

1.2

discoverObjects

public void discoverObjects(java.lang.Object[] roots,
                            java.util.Set<java.lang.Object> out)

Discovers all objects reachable from the roots and within the packages specified in the constructor. Objects that cannot be handled are neither added to the result nor recursively scanned.

Parameters:

roots - the root objects

out - the set to which results are added

Since:

1.2

discoverObjects

public void discoverObjects(java.util.Collection<?> roots,
                            java.util.Set<java.lang.Object> out)

Discovers all objects reachable from the roots and within the packages specified in the constructor. Objects that cannot be handled are neither added to the result nor recursively scanned.

Parameters:

roots - the root objects

out - the set to which results are added

Since:

1.2

canReflect

public boolean canReflect(java.lang.Object object)

Returns:

true if the given object is not null and can be handled by this reflector map, i.e. whether it's package name is part of the package names specified in the constructor, and false otherwise.

Since:

1.2

See Also:

canReflect(Class), canReflect(Package), canReflect(String)

canReflect

public boolean canReflect(java.lang.Class<?> type)

Returns:

true if the given class can be handled by this reflector map, i.e. whether it's package name is part of the package names specified in the constructor, and false otherwise.

Since:

1.2

See Also:

canReflect(Package), canReflect(String)

canReflect

public boolean canReflect(java.lang.Package thePackage)

Returns:

true if the given package can be handled by this reflector map, i.e. whether it's name is part of the package names specified in the constructor, and false otherwise.

Since:

1.2

See Also:

canReflect(String)

getReflector

public Reflector getReflector(java.lang.Object object)

Parameters:

object - the object whose class should be reflected

Returns:

a Reflector corresponding to the class of the given object, or a YamlObjectReflector if the object is a YamlObject.

Throws:

java.lang.NullPointerException - if object == null

java.lang.RuntimeException - if the given object cannot be handled by this reflector

Since:

1.2

getReflector

public Reflector getReflector(java.lang.Class<?> clazz)

Parameters:

clazz - the class to be reflected

Returns:

a Reflector corresponding to the given clazz

Throws:

java.lang.RuntimeException - if the given clazz cannot be handled by this reflector

Since:

1.2

getReflector

public Reflector getReflector(java.lang.String simpleName)

Parameters:

simpleName - the simple name of the class to be reflected

Returns:

a Reflector corresponding to the given Class with the given simpleName

Throws:

java.lang.RuntimeException - if the no class with the given simpleName can be found in the packages specified in the constructor

Since:

1.2