JkRunbase

java.lang.Object
- dev.jeka.core.tool.JkRunbase

```
public final class JkRunbase
extends java.lang.Object
```
Execution context associated with a base directory.
Each runBase has :
- A base directory from which JeKa resolves file paths. This base directory might contains a jeka-src subdirectory and/or a jeka.properties file at its root.
- A KBean registry for holding KBeans involved in the run context. There can be only one KBean instance per class within a runBase.
- A set of properties defined in [baseDir]/jeka.properties file
- A set of imported runBase
Typically, there is one runbase per project to build, sharing the same base dir.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends KBean> java.util.Optional<T>`	`find(java.lang.Class<T> beanClass)` Returns the KBean of the exact specified class, present in this runbase.
`static JkRunbase`	`get(java.nio.file.Path baseDir)` Returns the JkRunbase instance associated with the specified project base directory.
`java.nio.file.Path`	`getBaseDir()`
`java.util.List<KBean>`	`getBeans()` Returns the list of registered KBeans.
`JkBuildable`	`getBuildable()` Get either a ProjectKBean or a BaseKBean present in this runbase.
`java.lang.Class<? extends KBean>`	`getBuildableKBeanClass()`
`JkRunbase`	`getChildRunbase(java.lang.String name)`
`java.util.List<JkRunbase>`	`getChildRunbases()`
`JkPathSequence`	`getClasspath()` Returns the classpath used to compile jeka-src.
`JkDependencyResolver`	`getDependencyResolver()` Returns the dependency resolver used to fetch 3rd party build dependencies.
`JkPathSequence`	`getExportedClasspath()` Returns the exported classpath used by the JkRunbase instance.
`JkDependencySet`	`getExportedDependencies()` Returns the exported dependencies of the JkRunbase instance.
`JkDependencySet`	`getFullDependencies()` Returns the complete dependencies of the JkRunbase instance.
`JkPathSequence`	`getImportBaseDirs()` Returns root path of imported projects.
`JkProperties`	`getProperties()` Returns the JkProperties object associated with the current instance of JkRunBase.
`<T extends KBean> T`	`load(java.lang.Class<T> beanClass)` Instantiates the specified KBean into the current runbase, if it is not already present.
`<T extends KBean> java.util.List<T>`	`loadChildren(java.lang.Class<T> beanClass)`
`void`	`registerCLeanAction(java.lang.String name, java.lang.Runnable runnable)` Register extra file-system clean action to run when --clean option is specified.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - get
```
public static JkRunbase get(java.nio.file.Path baseDir)
```
    Returns the JkRunbase instance associated with the specified project base directory.
  - getDependencyResolver
```
public JkDependencyResolver getDependencyResolver()
```
    Returns the dependency resolver used to fetch 3rd party build dependencies.
  - getClasspath
```
public JkPathSequence getClasspath()
```
    Returns the classpath used to compile jeka-src.
  - getExportedClasspath
```
public JkPathSequence getExportedClasspath()
```
    Returns the exported classpath used by the JkRunbase instance.
    The exported classpath is the classpath minus 'private' dependencies. Private dependencies are declared using @JkDep in a class that is in package with root folder name stating with _.
  - getExportedDependencies
```
public JkDependencySet getExportedDependencies()
```
    Returns the exported dependencies of the JkRunbase instance.
    The exported dependencies is the dependencies minus 'private' dependencies. Private dependencies are declared using @JkDep in a class that is in package with root folder name stating with _.
  - getFullDependencies
```
public JkDependencySet getFullDependencies()
```
    Returns the complete dependencies of the JkRunbase instance. This values to exported + private dependencies.
  - getImportBaseDirs
```
public JkPathSequence getImportBaseDirs()
```
    Returns root path of imported projects.
  - find
```
public <T extends KBean> java.util.Optional<T> find(java.lang.Class<T> beanClass)
```
    Returns the KBean of the exact specified class, present in this runbase.
  - load
```
public <T extends KBean> T load(java.lang.Class<T> beanClass)
```
    Instantiates the specified KBean into the current runbase, if it is not already present.
    Since KBeans are singletons within a runbase, calling this method has no effect if the bean is already loaded.
    
    Parameters:
    
    beanClass - The class of the KBean to load.
    
    Returns:
    
    This object for call chaining.
  - getBeans
```
public java.util.List<KBean> getBeans()
```
    Returns the list of registered KBeans. A KBean is registered when it has been identified as the default KBean or when load(Class) is invoked.
  - getChildRunbases
```
public java.util.List<JkRunbase> getChildRunbases()
```
  - getChildRunbase
```
public JkRunbase getChildRunbase(java.lang.String name)
```
  - loadChildren
```
public <T extends KBean> java.util.List<T> loadChildren(java.lang.Class<T> beanClass)
```
  - getProperties
```
public JkProperties getProperties()
```
    Returns the JkProperties object associated with the current instance of JkRunBase. JkProperties is a class that holds key-value pairs of properties relevant to the execution of Jeka build tasks.
  - getBaseDir
```
public java.nio.file.Path getBaseDir()
```
  - getBuildable
```
public JkBuildable getBuildable()
```
    Get either a ProjectKBean or a BaseKBean present in this runbase. The result is returned as a JkBuildable abstraction.
    This methods never returns null, if no such KBean is present in the runbase a ProjectKBean is created if the presence of *src* dir is detected, otherwise it returns a BaseKBean instance.
  - getBuildableKBeanClass
```
public java.lang.Class<? extends KBean> getBuildableKBeanClass()
```
    Returns:
  - registerCLeanAction
```
public void registerCLeanAction(java.lang.String name,
                                java.lang.Runnable runnable)
```
    Register extra file-system clean action to run when --clean option is specified. This is used for KBeans as nodeJS that needs to clean an extra folder that does not belong to jeka-output. Important: This method should be called inside the a KBean #init() method in order it can be taken in account by the execution engine.
    
    Parameters:
    
    name -
    
    runnable -
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class JkRunbase

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

getDependencyResolver

getClasspath

getExportedClasspath

getExportedDependencies

getFullDependencies

getImportBaseDirs

find

load

getBeans

getChildRunbases

getChildRunbase

loadChildren

getProperties

getBaseDir

getBuildable

getBuildableKBeanClass

registerCLeanAction

toString