org.thales.punch.pml.scan

Class ClassPathScanner

java.lang.Object

org.thales.punch.pml.scan.ClassPathScanner

public class ClassPathScanner
extends Object

 Goals:
 1. be able to scan from class path a list of packages where;
      - each package may contain multiple class where;
      - each class may implement/extends our Public API for implementing custom Punchlines Node and;
      - each class meeting these requirements may/may not contains properties annotated with JsonProperty(from jackson lib)
 2. generating JSON documents by serializing all classes meeting above requirements. These JSON documents will be parse by our Punchline Editor
 

Internally, this class will try to scan from all java packages that are added as input by the user and tries to produce valid json documents that can be parse by punchline editor.

E.g. after coding your custom node, you might want to make your node available in Punchline Editor. This can be done by adding your custom_node.jar to this application classpath and by setting correct parameters (packages & runtime). This application will then generate a json document that can be parsed by our UI.

Author:

jonathan

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT
static String	EXECUTORS
static String	NAME
static String	PACKAGE
static String	PUBLISH
static String	SETTINGS
static String	SUBSCRIBE
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
ClassPathScanner(Class<?> baseClass, List<String> packages, String runtime)

Method Summary

Modifier and Type	Method and Description
String	asJson()
org.thales.punch.settings.api.ISettingsList	asSettingsList() All nodes serialized as ISettingsMap are returned

Methods inherited from class java.lang.Object

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

Field Detail

SETTINGS

public static final String SETTINGS

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

COMPONENT

public static final String COMPONENT

See Also:

Constant Field Values

PACKAGE

public static final String PACKAGE

See Also:

Constant Field Values

SUBSCRIBE

public static final String SUBSCRIBE

See Also:

Constant Field Values

PUBLISH

public static final String PUBLISH

See Also:

Constant Field Values

EXECUTORS

public static final String EXECUTORS

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ClassPathScanner

public ClassPathScanner(Class<?> baseClass,
                        List<String> packages,
                        String runtime)

Method Detail

asSettingsList

public org.thales.punch.settings.api.ISettingsList asSettingsList()
                                                           throws com.fasterxml.jackson.core.JsonProcessingException

All nodes serialized as ISettingsMap are returned

Returns:

A list of ISettingsMap

Throws:

com.fasterxml.jackson.core.JsonProcessingException

org.thales.punch.exceptions.SettingsException

asJson

public String asJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Returns:

a Json representation of all nodes

Throws:

com.fasterxml.jackson.core.JsonProcessingException

org.thales.punch.exceptions.SettingsException