ai.deepsense.commons.mail.templates.Template.scala Maven / Gradle / Ivy
/**
* Copyright 2016 deepsense.ai (CodiLime, Inc)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ai.deepsense.commons.mail.templates
import scala.util.Try
/**
* Type class representing a template
*
* The template class must be able to be loaded by name
* and must be able to be converted to String when it is provided a context
*
* @tparam T template class
*/
trait Template[T] {
type TemplateContext = Map[String, Any]
def loadTemplate(templateName: String): Try[T]
def renderTemplate(template: T, templateContext: TemplateContext): String
}