Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@zkingboos
zkingboos committed Jul 15, 2020
1 parent aabfbcd commit 99295f5
Show file tree
Hide file tree
Showing 119 changed files with 3,346 additions and 304 deletions.
98 changes: 65 additions & 33 deletions docs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Sun Jul 12 10:54:33 BRT 2020 -->
<!-- Generated by javadoc (14.0.1) on Wed Jul 15 09:55:10 BRT 2020 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-07-12">
<meta name="dc.created" content="2020-07-15">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -20,8 +20,8 @@
<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
</head>
<body class="all-classes-index">
<script type="text/javascript">var data = {"i0":2,"i1":2,"i2":2,"i3":1,"i4":2,"i5":2,"i6":2,"i7":2,"i8":32,"i9":32,"i10":1,"i11":2,"i12":1,"i13":1,"i14":2,"i15":2,"i16":1,"i17":2,"i18":2,"i19":32,"i20":2,"i21":1,"i22":2,"i23":2,"i24":1,"i25":2,"i26":1,"i27":2,"i28":2,"i29":4,"i30":2,"i31":4,"i32":32,"i33":2,"i34":1,"i35":2,"i36":1,"i37":2,"i38":1};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],32:["t6","Annotation Types Summary"]};
<script type="text/javascript">var data = {"i0":2,"i1":2,"i2":2,"i3":1,"i4":2,"i5":2,"i6":2,"i7":2,"i8":32,"i9":32,"i10":8,"i11":1,"i12":2,"i13":1,"i14":1,"i15":2,"i16":2,"i17":1,"i18":2,"i19":2,"i20":32,"i21":2,"i22":1,"i23":2,"i24":2,"i25":1,"i26":2,"i27":1,"i28":2,"i29":2,"i30":4,"i31":2,"i32":4,"i33":8,"i34":8,"i35":8,"i36":16,"i37":16,"i38":32,"i39":2,"i40":1,"i41":2,"i42":1,"i43":2,"i44":8,"i45":1,"i46":8};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"],16:["t5","Error Summary"],32:["t6","Annotation Types Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
Expand Down Expand Up @@ -71,7 +71,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<div class="typeSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="typeSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Classes</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Interface Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Class Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Enum Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Annotation Types Summary</button></div>
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="typeSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Classes</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Interface Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Class Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Enum Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Exception Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="tableTab" onclick="show(16);">Error Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Annotation Types Summary</button></div>
<div id="typeSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
Expand Down Expand Up @@ -131,159 +131,191 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</th>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><a href="io/king/core/api/exception/InjectableException.html" title="class in io.king.core.api.exception">InjectableException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><a href="io/king/core/api/di/InjectionManager.html" title="interface in io.king.core.api.di">InjectionManager</a></td>
<th class="colLast" scope="row">
<div class="block">Used to inject instances of fields annotated with @Inject</div>
</th>
</tr>
<tr class="rowColor" id="i11">
<tr class="altColor" id="i12">
<td class="colFirst"><a href="io/king/core/provider/di/InjectionManagerImpl.html" title="class in io.king.core.provider.di">InjectionManagerImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i12">
<tr class="rowColor" id="i13">
<td class="colFirst"><a href="io/king/core/api/KingApi.html" title="interface in io.king.core.api">KingApi</a></td>
<th class="colLast" scope="row">
<div class="block">Heart of core</div>
</th>
</tr>
<tr class="rowColor" id="i13">
<tr class="altColor" id="i14">
<td class="colFirst"><a href="io/king/core/api/cycle/LifeContext.html" title="interface in io.king.core.api.cycle">LifeContext</a></td>
<th class="colLast" scope="row">
<div class="block">Context of life-cycle class
This class is responsible to "export" api to modules</div>
</th>
</tr>
<tr class="altColor" id="i14">
<tr class="rowColor" id="i15">
<td class="colFirst"><a href="io/king/core/provider/cycle/LifeContextImpl.html" title="class in io.king.core.provider.cycle">LifeContextImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i15">
<tr class="altColor" id="i16">
<td class="colFirst"><a href="io/king/core/api/cycle/LifeCycle.html" title="class in io.king.core.api.cycle">LifeCycle</a></td>
<th class="colLast" scope="row">
<div class="block">Cycle of core
This class is responsible to create instance of modules</div>
</th>
</tr>
<tr class="altColor" id="i16">
<tr class="rowColor" id="i17">
<td class="colFirst"><a href="io/king/core/api/cycle/LifeEvent.html" title="interface in io.king.core.api.cycle">LifeEvent</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i17">
<tr class="altColor" id="i18">
<td class="colFirst"><a href="io/king/core/provider/cycle/LifeEventImpl.html" title="class in io.king.core.provider.cycle">LifeEventImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i18">
<tr class="rowColor" id="i19">
<td class="colFirst"><a href="io/king/core/provider/cycle/ListenerObject.html" title="class in io.king.core.provider.cycle">ListenerObject</a>&lt;<a href="io/king/core/provider/cycle/ListenerObject.html" title="type parameter in ListenerObject">T</a>&gt;</td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i19">
<tr class="altColor" id="i20">
<td class="colFirst"><a href="io/king/core/api/module/Module.html" title="annotation in io.king.core.api.module">Module</a></td>
<th class="colLast" scope="row">
<div class="block">The all files needs to be annotated with @Module
It indicate that file is valid and core can load him</div>
</th>
</tr>
<tr class="altColor" id="i20">
<tr class="rowColor" id="i21">
<td class="colFirst"><a href="io/king/core/api/module/ModuleConfig.html" title="class in io.king.core.api.module">ModuleConfig</a></td>
<th class="colLast" scope="row">
<div class="block">Used to identify authors and version
And can integrate with my website in future</div>
</th>
</tr>
<tr class="rowColor" id="i21">
<tr class="altColor" id="i22">
<td class="colFirst"><a href="io/king/core/api/module/ModuleContainer.html" title="interface in io.king.core.api.module">ModuleContainer</a></td>
<th class="colLast" scope="row">
<div class="block">ModuleContainer is a singleton instance
Used to get ModuleManager from each plugin</div>
</th>
</tr>
<tr class="altColor" id="i22">
<tr class="rowColor" id="i23">
<td class="colFirst"><a href="io/king/core/provider/module/ModuleContainerImpl.html" title="class in io.king.core.provider.module">ModuleContainerImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i23">
<tr class="altColor" id="i24">
<td class="colFirst"><a href="io/king/core/provider/cycle/event/ModuleInitialized.html" title="class in io.king.core.provider.cycle.event">ModuleInitialized</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i24">
<tr class="rowColor" id="i25">
<td class="colFirst"><a href="io/king/core/api/module/ModuleManager.html" title="interface in io.king.core.api.module">ModuleManager</a></td>
<th class="colLast" scope="row">
<div class="block">Tree of modules
Here you can get the all loaded modules</div>
</th>
</tr>
<tr class="rowColor" id="i25">
<tr class="altColor" id="i26">
<td class="colFirst"><a href="io/king/core/provider/module/ModuleManagerImpl.html" title="class in io.king.core.provider.module">ModuleManagerImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i26">
<tr class="rowColor" id="i27">
<td class="colFirst"><a href="io/king/core/api/module/ModuleModel.html" title="interface in io.king.core.api.module">ModuleModel</a></td>
<th class="colLast" scope="row">
<div class="block">This class takes the responsability to load Models Manager</div>
</th>
</tr>
<tr class="rowColor" id="i27">
<tr class="altColor" id="i28">
<td class="colFirst"><a href="io/king/core/provider/module/ModuleModelImpl.html" title="class in io.king.core.provider.module">ModuleModelImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i28">
<tr class="rowColor" id="i29">
<td class="colFirst"><a href="io/king/core/provider/module/ModuleObject.html" title="class in io.king.core.provider.module">ModuleObject</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i29">
<tr class="altColor" id="i30">
<td class="colFirst"><a href="io/king/core/api/module/ModulePriority.html" title="enum in io.king.core.api.module">ModulePriority</a></td>
<th class="colLast" scope="row">
<div class="block">Priority defines the order where module is loaded
System is be loaded first of normal</div>
</th>
</tr>
<tr class="altColor" id="i30">
<tr class="rowColor" id="i31">
<td class="colFirst"><a href="io/king/core/provider/module/ModuleProps.html" title="class in io.king.core.provider.module">ModuleProps</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i31">
<tr class="altColor" id="i32">
<td class="colFirst"><a href="io/king/core/api/module/stage/ModuleStage.html" title="enum in io.king.core.api.module.stage">ModuleStage</a></td>
<th class="colLast" scope="row">
<div class="block">Stage of module</div>
</th>
</tr>
<tr class="altColor" id="i32">
<tr class="rowColor" id="i33">
<td class="colFirst"><a href="io/king/core/api/exception/module/NoSuchModuleException.html" title="class in io.king.core.api.exception.module">NoSuchModuleException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i34">
<td class="colFirst"><a href="io/king/core/api/exception/service/NoSuchServiceException.html" title="class in io.king.core.api.exception.service">NoSuchServiceException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i35">
<td class="colFirst"><a href="io/king/core/api/exception/service/NoSuchServiceRegistryException.html" title="class in io.king.core.api.exception.service">NoSuchServiceRegistryException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i36">
<td class="colFirst"><a href="io/king/core/api/exception/module/OverflowSoftDependException.html" title="class in io.king.core.api.exception.module">OverflowSoftDependException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i37">
<td class="colFirst"><a href="io/king/core/api/exception/service/RedundantServiceException.html" title="class in io.king.core.api.exception.service">RedundantServiceException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i38">
<td class="colFirst"><a href="io/king/core/api/service/Service.html" title="annotation in io.king.core.api.service">Service</a></td>
<th class="colLast" scope="row">
<div class="block">Service serve as life-cycle but inside of module</div>
</th>
</tr>
<tr class="rowColor" id="i33">
<tr class="rowColor" id="i39">
<td class="colFirst"><a href="io/king/core/provider/cycle/strategy/ServiceCycle.html" title="class in io.king.core.provider.cycle.strategy">ServiceCycle</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i34">
<tr class="altColor" id="i40">
<td class="colFirst"><a href="io/king/core/api/service/ServiceEntity.html" title="interface in io.king.core.api.service">ServiceEntity</a>&lt;<a href="io/king/core/api/service/ServiceEntity.html" title="type parameter in ServiceEntity">T</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">Entity of service, where you can obtain the service and registration service</div>
</th>
</tr>
<tr class="rowColor" id="i35">
<tr class="rowColor" id="i41">
<td class="colFirst"><a href="io/king/core/provider/service/ServiceEntityImpl.html" title="class in io.king.core.provider.service">ServiceEntityImpl</a>&lt;<a href="io/king/core/provider/service/ServiceEntityImpl.html" title="type parameter in ServiceEntityImpl">T</a>&gt;</td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i36">
<tr class="altColor" id="i42">
<td class="colFirst"><a href="io/king/core/api/service/ServiceManager.html" title="interface in io.king.core.api.service">ServiceManager</a></td>
<th class="colLast" scope="row">
<div class="block">Manager of services
This is used to share instance with others modules</div>
</th>
</tr>
<tr class="rowColor" id="i37">
<tr class="rowColor" id="i43">
<td class="colFirst"><a href="io/king/core/provider/service/ServiceManagerImpl.html" title="class in io.king.core.provider.service">ServiceManagerImpl</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="altColor" id="i38">
<tr class="altColor" id="i44">
<td class="colFirst"><a href="io/king/core/api/exception/service/ServiceTypeInvoke.html" title="class in io.king.core.api.exception.service">ServiceTypeInvoke</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr class="rowColor" id="i45">
<td class="colFirst"><a href="io/king/core/api/cycle/strategy/StrategyCycle.html" title="interface in io.king.core.api.cycle.strategy">StrategyCycle</a></td>
<th class="colLast" scope="row">
<div class="block">Strategy Pattern</div>
</th>
</tr>
<tr class="altColor" id="i46">
<td class="colFirst"><a href="io/king/core/api/exception/module/UnknownModuleConfigException.html" title="class in io.king.core.api.exception.module">UnknownModuleConfigException</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
</tbody>
</table>
</div>
Expand Down
Loading

0 comments on commit 99295f5

Please sign in to comment.