From b5544193815721f6b69c442d0a6bcf3d790d48e3 Mon Sep 17 00:00:00 2001
From: Sheldan <5037282+Sheldan@users.noreply.github.com>
Date: Tue, 26 May 2020 12:40:06 +0200
Subject: [PATCH] updated java doc in templating

---
 .../templating/service/TemplateServiceBean.java  | 11 ++++++++++-
 .../TemplateManagementServiceBean.java           | 16 ++++++++++++++++
 .../templating/model/database/Template.java      |  6 ++++++
 .../templating/service/TemplateService.java      | 12 ++++++++++++
 4 files changed, 44 insertions(+), 1 deletion(-)

diff --git a/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/TemplateServiceBean.java b/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/TemplateServiceBean.java
index 9422588ce..9c0c0d7e9 100644
--- a/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/TemplateServiceBean.java
+++ b/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/TemplateServiceBean.java
@@ -33,7 +33,6 @@ public class TemplateServiceBean implements TemplateService {
     @Autowired
     private Gson gson;
 
-
     /**
      * Formats the passed passed count with the embed used for formatting pages.
      * @param count The index of the page you want formated.
@@ -169,11 +168,21 @@ public class TemplateServiceBean implements TemplateService {
         }
     }
 
+    /**
+     * Renders a simple template identified by key without any model. This will cause exceptions in case there are references to a model in the provided template.
+     * @param key The key of the template to be rendered
+     * @return The rendered template as a string
+     */
     @Override
     public String renderSimpleTemplate(String key) {
         return renderTemplate(key, new Object());
     }
 
+    /**
+     * Renders the {@link Templatable} object using the template key and the model and returns it as a string.
+     * @param templatable The {@link Templatable} object to be rendered
+     * @return The rendered {@link Templatable} as a string
+     */
     @Override
     public String renderTemplatable(Templatable templatable) {
         return renderTemplate(templatable.getTemplateName(), templatable.getTemplateModel());
diff --git a/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/management/TemplateManagementServiceBean.java b/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/management/TemplateManagementServiceBean.java
index f6aa8c826..1908950bc 100644
--- a/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/management/TemplateManagementServiceBean.java
+++ b/abstracto-application/templating/templating-impl/src/main/java/dev/sheldan/abstracto/templating/service/management/TemplateManagementServiceBean.java
@@ -20,16 +20,32 @@ public class TemplateManagementServiceBean implements TemplateManagementService
     @Autowired
     private TemplateRepository repository;
 
+    /**
+     * Returns the template from the database by key
+     * @param key They template key to search for
+     * @return An {@link Optional} containing the {@link Template} if any was found.
+     */
     @Override
     public Optional<Template> getTemplateByKey(String key) {
         return repository.findById(key);
     }
 
+    /**
+     * Returns whether or not the template identified by the key exists in the database
+     * @param key They key of the template to search for
+     * @return Whether or not the template exists in the database
+     */
     @Override
     public boolean templateExists(String key) {
         return repository.existsById(key);
     }
 
+    /**
+     * Creates a {@link Template} object and stores it in the database. Returns the newly created object.
+     * @param key They key of the template to create.
+     * @param content The content the template should have
+     * @return The {@link Template} which was created
+     */
     @Override
     public Template createTemplate(String key, String content) {
         Template build = Template.builder().key(key).content(content).lastModified(Instant.now()).build();
diff --git a/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/model/database/Template.java b/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/model/database/Template.java
index a377db6a1..c9acd8ce0 100644
--- a/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/model/database/Template.java
+++ b/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/model/database/Template.java
@@ -42,6 +42,9 @@ public class Template {
     @Getter
     private Instant lastModified;
 
+    /**
+     * The time this template was created in the database
+     */
     @Column(name = "created")
     private Instant created;
 
@@ -50,6 +53,9 @@ public class Template {
         this.created = Instant.now();
     }
 
+    /**
+     * The time this template was updated in the database, only works when using the bot, does not work with triggers.
+     */
     @Column(name = "updated")
     private Instant updated;
 
diff --git a/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/service/TemplateService.java b/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/service/TemplateService.java
index 1fbd82419..e16151a49 100644
--- a/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/service/TemplateService.java
+++ b/abstracto-application/templating/templating-interface/src/main/java/dev/sheldan/abstracto/templating/service/TemplateService.java
@@ -33,7 +33,19 @@ public interface TemplateService {
      * @return The template rendered as string.
      */
     String renderTemplate(String key, Object model);
+
+    /**
+     * Renders the template without considering any model to be used. If a property is used in the given template, this will throw an exception.
+     * This is just a quick way to render templates, which do not *need* a model.
+     * @param key The key of the template to be rendered
+     * @return The template rendered as string
+     */
     String renderSimpleTemplate(String key);
 
+    /**
+     * Renders the given {@link Templatable} object, which means it retrieves the template key and renders the given template key with the given model.
+     * @param templatable The {@link Templatable} object to be rendered
+     * @return The template rendered as string
+     */
     String renderTemplatable(Templatable templatable);
 }