com.fluxtion.compiler.generation

Class GenerationContext

java.lang.Object

com.fluxtion.compiler.generation.GenerationContext

public class GenerationContext
extends Object

Context for the generated output of the SEP. Provides functions to control generation outputs from Fluxtion, but is not used to describe the graph processing structure of a SEP.

Author:

Greg Higgins

Field Summary

Fields

Modifier and Type	Field and Description
static ClassLoader	DEFAULT_CLASSLOADER
File	resourcesOutputDirectory
File	resourcesRootDirectory the output directory for the code generation
static GenerationContext	SINGLETON

Constructor Summary

Constructors

Constructor and Description
GenerationContext(String packageName, String sepClassName, File outputDirectory, File resourcesRootDirectory)

Method Summary

Modifier and Type	Method and Description
<T> T	addOrUseExistingNode(T node)
void	createResourceDirectory()
<K,V> Map<K,V>	getCache(Object key) a cache that is tied to this generation context instance.
List<Object>	getNodeList()
<T> T	nameNode(T node, String name)
static int	nextId() A global counter, can be used for generating unique class names.
int	nextId(String className)
static String	readText(String resourceName)
<K,V> Map<K,V>	removeCache(Object key) removes a cache map from this instance by key.
static void	setupStaticContext(ClassLoader classLoader, String packageName, String className, File outputDirectory, File resourcesRootDirectory, boolean createResourceDirectory, File buildOutputDirectory, boolean createBuildOutputDirectory)
static void	setupStaticContext(String packageName, String className, File outputDirectory, File resourcesRootDirectory)
static void	setupStaticContext(String packageName, String className, File outputDirectory, File resourcesRootDirectory, boolean createResourceDirectory)

Methods inherited from class java.lang.Object

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

Field Detail

SINGLETON

public static GenerationContext SINGLETON

DEFAULT_CLASSLOADER

public static ClassLoader DEFAULT_CLASSLOADER

resourcesRootDirectory

public File resourcesRootDirectory

the output directory for the code generation

resourcesOutputDirectory

public File resourcesOutputDirectory

Constructor Detail

GenerationContext

public GenerationContext(String packageName,
                         String sepClassName,
                         File outputDirectory,
                         File resourcesRootDirectory)

Method Detail

nextId

public static int nextId()

A global counter, can be used for generating unique class names.

Returns:

next id.

nextId

public int nextId(String className)

setupStaticContext

public static void setupStaticContext(String packageName,
                                      String className,
                                      File outputDirectory,
                                      File resourcesRootDirectory)

setupStaticContext

public static void setupStaticContext(String packageName,
                                      String className,
                                      File outputDirectory,
                                      File resourcesRootDirectory,
                                      boolean createResourceDirectory)

setupStaticContext

public static void setupStaticContext(ClassLoader classLoader,
                                      String packageName,
                                      String className,
                                      File outputDirectory,
                                      File resourcesRootDirectory,
                                      boolean createResourceDirectory,
                                      File buildOutputDirectory,
                                      boolean createBuildOutputDirectory)

createResourceDirectory

public void createResourceDirectory()

getNodeList

public List<Object> getNodeList()

addOrUseExistingNode

public <T> T addOrUseExistingNode(T node)

getCache

public <K,V> Map<K,V> getCache(Object key)

a cache that is tied to this generation context instance. A new Map will be created for each unique cache key.

Type Parameters:

K - The key type of the cache map

V - The value type of the cache map

Parameters:

key - the cache key

Returns:

the newly created map

nameNode

public <T> T nameNode(T node,
                      String name)

removeCache

public <K,V> Map<K,V> removeCache(Object key)

removes a cache map from this instance by key.

Type Parameters:

K - The key type of the cache map

V - The value type of the cache map

Parameters:

key - the cache key

Returns:

The mapping of the map removed or null if no mapping

readText

public static String readText(@NotNull
                              String resourceName)
                       throws IOException

Throws:

IOException