Context

hep.dataforge.context.Context

All Implemented Interfaces:

MetaID, Named, Provider, ValueProvider

Direct Known Subclasses:

Global
```
public class Context
implements Provider, ValueProvider, Named, MetaID
```
The local environment for anything being done in DataForge framework. Contexts are organized into tree structure with class Global at the top. Each context has a set of named interface Value properties which are taken from parent context in case they are not found in local context. Context implements interface ValueProvider interface and therefore could be uses as a value source for substitutions etc. Context contains class PluginManager which could be used any number of configurable named plugins. Also Context has its own logger and class IOManager to govern all the input and output being made inside the context.

See Also:

class Global, interface Value, interface ValueProvider, class PluginManager, class IOManager

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Context.Companion

Nested Classes
Modifier and Type	Class and Description
`static class`	`Context.Companion`

Field Summary

Fields
Modifier and Type Field and Description

static Context.Companion Companion
- Fields inherited from interface hep.dataforge.values.ValueProvider
  BOOLEAN_TARGET, NUMBER_TARGET, STRING_TARGET, TIME_TARGET, VALUE_TARGET
- Fields inherited from interface hep.dataforge.names.Named
  ANONYMOUS

Fields
Modifier and Type	Field and Description
`static Context.Companion`	`Companion`

Constructor Summary

Constructors
Constructor and Description
`Context(java.lang.String name, Context parent, java.lang.ClassLoader classLoader)` The local environment for anything being done in DataForge framework. Contexts are organized into tree structure with `class Global` at the top. Each context has a set of named `interface Value` properties which are taken from parent context in case they are not found in local context. Context implements `interface ValueProvider` interface and therefore could be uses as a value source for substitutions etc. Context contains `class PluginManager` which could be used any number of configurable named plugins. Also Context has its own logger and `class IOManager` to govern all the input and output being made inside the context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Free up resources associated with this context
`java.lang.String`	`defaultTarget()`
`<T> java.util.Optional<T>`	`findService(java.lang.Class<T> serviceClass, java.util.function.Predicate<T> predicate)` Find specific service provided by java SPI
`<T> T`	`get(java.lang.Class<T> type)` Get a plugin extending given class
`java.lang.ClassLoader`	`getClassLoader()` A class loader for this context. Parent class loader is used by default
`java.util.concurrent.ExecutorService`	`getDispatcher()` A dispatch thread executor for current context
`ExecutorPlugin`	`getExecutors()`
`Chronicler`	`getHistory()`
`IOManager`	`getIo()` Return IO manager of this context. By default parent IOManager is returned.
`NonExistentClass`	`getLogger()`
`java.lang.String`	`getName()` The name of the context
`Context`	`getParent()`
`PluginManager`	`getPluginManager()` Plugin manager for this Context
`java.util.Map<java.lang.String,hep.dataforge.values.Value>`	`getProperties()`
`boolean`	`isLocked()` Find out if context is locked
`java.util.Collection<java.lang.String>`	`listPlugins()`
`java.util.Collection<java.lang.String>`	`listValues()`
`<T extends Plugin> T`	`load(java.lang.Class<T> type, Meta meta)`
`<T extends Plugin> T`	`load(KClass<T> type, Meta meta)`
`void`	`lock(java.lang.Object obj)` Lock this context by given object
`<T> java.util.Optional<T>`	`optFeature(java.lang.Class<T> type)` Opt a plugin extending given class
`java.util.Optional<hep.dataforge.context.Plugin>`	`optPlugin(java.lang.String pluginName)`
`java.util.Optional<hep.dataforge.values.Value>`	`optValue(java.lang.String path)` {@inheritDoc} namespace does not work
`<T> java.util.stream.Stream<T>`	`serviceStream(java.lang.Class<T> serviceClass)` Get stream of services of given class provided by Java SPI or any other service loading API.
`void`	`setLogger(NonExistentClass p)`
`void`	`setValue(java.lang.String name, java.lang.Object value)` Add property to context
`Meta`	`toMeta()` Get identity for this context
`void`	`unlock(java.lang.Object obj)` Unlock the context by given object

Methods inherited from interface hep.dataforge.providers.Provider
defaultChainTarget, defaultTarget, listContent, provide, provide, provide

Methods inherited from interface hep.dataforge.values.ValueProvider
buildFrom, getBoolean, getBoolean, getBoolean, getDouble, getDouble, getDouble, getInt, getInt, getInt, getString, getString, getString, getStringArray, getStringArray, getStringArray, getValue, getValue, getValue, hasValue, optBoolean, optNumber, optString, optTime, optValue

Methods inherited from interface hep.dataforge.names.Named
getName, isAnonimous, nameOf

Methods inherited from interface hep.dataforge.meta.MetaID
toMeta

- Field Detail
  - Companion
```
public static Context.Companion Companion
```
- Constructor Detail
  - Context
```
public Context(java.lang.String name,
               Context parent,
               java.lang.ClassLoader classLoader)
```
    The local environment for anything being done in DataForge framework. Contexts are organized into tree structure with class Global at the top. Each context has a set of named interface Value properties which are taken from parent context in case they are not found in local context. Context implements interface ValueProvider interface and therefore could be uses as a value source for substitutions etc. Context contains class PluginManager which could be used any number of configurable named plugins. Also Context has its own logger and class IOManager to govern all the input and output being made inside the context.
    
    See Also:
    
    class Global, interface Value, interface ValueProvider, class PluginManager, class IOManager
- Method Detail
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
    A class loader for this context. Parent class loader is used by default
  - getPluginManager
```
public PluginManager getPluginManager()
```
    Plugin manager for this Context
    
    Returns:
  - getLogger
```
public NonExistentClass getLogger()
```
  - setLogger
```
public void setLogger(NonExistentClass p)
```
  - getIo
```
public IOManager getIo()
```
    Return IO manager of this context. By default parent IOManager is returned.
    
    Returns:
    
    the io
  - getDispatcher
```
public java.util.concurrent.ExecutorService getDispatcher()
```
    A dispatch thread executor for current context
    
    Returns:
  - getExecutors
```
public ExecutorPlugin getExecutors()
```
  - isLocked
```
public boolean isLocked()
```
    Find out if context is locked
    
    Returns:
  - getHistory
```
public Chronicler getHistory()
```
  - optValue
```
public java.util.Optional<hep.dataforge.values.Value> optValue(java.lang.String path)
```
    {@inheritDoc} namespace does not work
  - getName
```
public java.lang.String getName()
```
    The name of the context
    
    Returns:
  - setValue
```
public void setValue(java.lang.String name,
                     java.lang.Object value)
```
    Add property to context
    
    Parameters:
    
    name -
    
    value -
  - defaultTarget
```
public java.lang.String defaultTarget()
```
  - optPlugin
```
public java.util.Optional<hep.dataforge.context.Plugin> optPlugin(java.lang.String pluginName)
```
  - listPlugins
```
public java.util.Collection<java.lang.String> listPlugins()
```
  - listValues
```
public java.util.Collection<java.lang.String> listValues()
```
  - getProperties
```
public java.util.Map<java.lang.String,hep.dataforge.values.Value> getProperties()
```
  - get
```
public <T> T get(java.lang.Class<T> type)
```
    Get a plugin extending given class
    
    Parameters:
    
    type -
    
    Returns:
  - load
```
public <T extends Plugin> T load(java.lang.Class<T> type,
                                 Meta meta)
```
  - load
```
public <T extends Plugin> T load(KClass<T> type,
                                 Meta meta)
```
  - optFeature
```
public <T> java.util.Optional<T> optFeature(java.lang.Class<T> type)
```
    Opt a plugin extending given class
    
    Parameters:
    
    type -
    
    Returns:
  - serviceStream
```
public <T> java.util.stream.Stream<T> serviceStream(java.lang.Class<T> serviceClass)
```
    Get stream of services of given class provided by Java SPI or any other service loading API.
    
    Parameters:
    
    serviceClass -
    
    Returns:
  - findService
```
public <T> java.util.Optional<T> findService(java.lang.Class<T> serviceClass,
                                             java.util.function.Predicate<T> predicate)
```
    Find specific service provided by java SPI
    
    Parameters:
    
    serviceClass -
    
    predicate -
    
    Returns:
  - toMeta
```
public Meta toMeta()
```
    Get identity for this context
    
    Returns:
  - lock
```
public void lock(java.lang.Object obj)
```
    Lock this context by given object
    
    Parameters:
    
    obj -
  - unlock
```
public void unlock(java.lang.Object obj)
```
    Unlock the context by given object
    
    Parameters:
    
    obj -
  - close
```
public void close()
```
    Free up resources associated with this context
    
    Throws:
  - getParent
```
public Context getParent()
```

Class Context

Nested Class Summary

Field Summary

Fields inherited from interface hep.dataforge.values.ValueProvider

Fields inherited from interface hep.dataforge.names.Named

Constructor Summary

Method Summary

Methods inherited from interface hep.dataforge.providers.Provider

Methods inherited from interface hep.dataforge.values.ValueProvider

Methods inherited from interface hep.dataforge.names.Named

Methods inherited from interface hep.dataforge.meta.MetaID

Field Detail

Companion

Constructor Detail

Context

Method Detail

getClassLoader

getPluginManager

getLogger

setLogger

getIo

getDispatcher

getExecutors

isLocked

getHistory

optValue

getName

setValue

defaultTarget

optPlugin

listPlugins

listValues

getProperties

get

load

load

optFeature

serviceStream

findService

toMeta

lock

unlock

close

getParent