com.netflix.nicobar.core.module

Class ScriptModuleUtils

java.lang.Object

com.netflix.nicobar.core.module.ScriptModuleUtils

public class ScriptModuleUtils
extends java.lang.Object

Utility classes for ScriptModule processing

Constructor Summary

Constructors

Constructor and Description
ScriptModuleUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Class<?>	findAssignableClass(ScriptModule module, java.lang.Class<?> targetClass) Find the first class in the module that is a subclasses or equal to the target class
static java.util.Set<java.lang.Class<?>>	findAssignableClasses(ScriptModule module, java.lang.Class<?> targetClass) Find all of the classes in the module that are subclasses or equal to the target class
static java.lang.Class<?>	findClass(ScriptModule module, java.lang.String className) Find a class in the module that matches the given className
static void	toCompiledScriptArchive(ScriptModule module, java.nio.file.Path jarPath, java.util.Set<java.lang.String> excludeExtensions) Convert a ScriptModule to its compiled equivalent ScriptArchive.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptModuleUtils

public ScriptModuleUtils()

Method Detail

findAssignableClasses

public static java.util.Set<java.lang.Class<?>> findAssignableClasses(ScriptModule module,
                                                      java.lang.Class<?> targetClass)

Find all of the classes in the module that are subclasses or equal to the target class

Parameters:

module - module to search

targetClass - target type to search for

Returns:

first instance that matches the given type

findAssignableClass

@Nullable
public static java.lang.Class<?> findAssignableClass(ScriptModule module,
                                              java.lang.Class<?> targetClass)

Find the first class in the module that is a subclasses or equal to the target class

Parameters:

module - module to search

targetClass - target type to search for

Returns:

first instance that matches the given type

findClass

@Nullable
public static java.lang.Class<?> findClass(ScriptModule module,
                                    java.lang.String className)

Find a class in the module that matches the given className

Parameters:

module - the script module to search

className - the class name in dotted form.

Returns:

the found class, or null.

toCompiledScriptArchive

public static void toCompiledScriptArchive(ScriptModule module,
                           java.nio.file.Path jarPath,
                           java.util.Set<java.lang.String> excludeExtensions)
                                    throws java.lang.Exception

Convert a ScriptModule to its compiled equivalent ScriptArchive.

A jar script archive is created containing compiled bytecode from a script module, as well as resources and other metadata from the source script archive.

This involves serializing the class bytes of all the loaded classes in the script module, as well as copying over all entries in the original script archive, minus any that have excluded extensions. The module spec of the source script archive is transferred as is to the target bytecode archive.

Parameters:

module - the input script module containing loaded classes

jarPath - the path to a destination JarScriptArchive.

excludeExtensions - a set of extensions with which source script archive entries can be excluded.

Throws:

java.lang.Exception