nz.net.ultraq.thymeleaf.layoutdialect.models.ModelBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-layout-dialect Show documentation
Thymeleaf Layout Dialect rewritten in java.
The newest version!
/*
 * Copyright 2016, Emanuel Rabina (http://www.ultraq.net.nz/)
 *
 * 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 nz.net.ultraq.thymeleaf.layoutdialect.models;

import groovy.lang.Closure;
import groovy.util.BuilderSupport;
import org.codehaus.groovy.runtime.DefaultGroovyMethods;
import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
import org.thymeleaf.context.ITemplateContext;
import org.thymeleaf.engine.ElementDefinitions;
import org.thymeleaf.model.IModel;
import org.thymeleaf.model.IModelFactory;
import org.thymeleaf.templatemode.TemplateMode;

import java.util.Map;

/**
 * Create Thymeleaf 3.0 models using a simplified syntax.
 *
 * @author zhanhb
 * @author Emanuel Rabina
 */
@SuppressWarnings("unchecked")
public class ModelBuilder extends BuilderSupport {

	private final nz.net.ultraq.thymeleaf.layoutdialect.internal.ModelBuilder builder;

	private static IModel castToModel(Object object) {
		return (IModel) DefaultTypeTransformation.castToType(object, IModel.class);
	}

	private static String nullableToString(Object object) {
		return object != null ? DefaultGroovyMethods.toString(object) : null;
	}

	/**
	 * Constructor, create a new model builder.
	 *
	 * @param context
	 */
	public ModelBuilder(ITemplateContext context) {
		builder = new nz.net.ultraq.thymeleaf.layoutdialect.internal.ModelBuilder(context);
	}

	/**
	 * Constructor, create a new model builder.
	 *
	 * @param modelFactory
	 * @param elementDefinitions
	 * @param templateMode
	 */
	public ModelBuilder(IModelFactory modelFactory, ElementDefinitions elementDefinitions, TemplateMode templateMode) {
		builder = new nz.net.ultraq.thymeleaf.layoutdialect.internal.ModelBuilder(modelFactory, elementDefinitions, templateMode);
	}

	/**
	 * Appends an existing model to the model being built.
	 *
	 * @param model
	 */
	public void add(IModel model) {
		IModel current = castToModel(getCurrent());
		current.insertModel(current.size() - 1, model);
	}

	/**
	 * Captures the top `build` call so that it doesn't end up as a node in the
	 * final model.
	 *
	 * @param definition
	 * @return The model built using the closure definition.
	 */
	public IModel build(Closure definition) {
		setClosureDelegate(definition, null);
		return castToModel(definition.call());
	}

	/**
	 * Create a model for the given HTML element.
	 *
	 * @param name HTML element name.
	 * @return New model with the given name.
	 */
	@Override
	protected Object createNode(Object name) {
		return builder.createNode(DefaultGroovyMethods.toString(name));
	}

	/**
	 * Create a model for the given HTML element and inner text content.
	 *
	 * @param name  HTML element name.
	 * @param value Text content.
	 * @return New model with the given name and content.
	 */
	@Override
	protected Object createNode(Object name, Object value) {
		return builder.createNode(DefaultGroovyMethods.toString(name), nullableToString(value));
	}

	/**
	 * Create a model for the given HTML element and attributes.
	 *
	 * @param name       HTML element name.
	 * @param attributes Element attributes.
	 * @return New model with the given name and attributes.
	 */
	@Override
	protected Object createNode(Object name, Map attributes) {
		return builder.createNode(DefaultGroovyMethods.toString(name), attributes);
	}

	/**
	 * Create a model for the given HTML element, attributes, and inner text
	 * content.
	 *
	 * @param name       HTML element name.
	 * @param attributes Element attributes.
	 * @param value      Text content.
	 * @return New model with the given name, attributes, and content.
	 */
	@Override
	protected IModel createNode(Object name, Map attributes, Object value) {
		return builder.createNode(DefaultGroovyMethods.toString(name), attributes, nullableToString(value));
	}

	/**
	 * Link a parent and child node. A child node is appended to a parent by
	 * being the last sub-model before the parent close tag.
	 *
	 * @param parent
	 * @param child
	 */
	@Override
	protected void nodeCompleted(Object parent, Object child) {
		builder.nodeCompleted(castToModel(parent), castToModel(child));
	}

	/**
	 * Does nothing. Because models only copy events when added to one another,
	 * we can't just add child events at this point - we need to wait until that
	 * child has had it's children added, and so on. So the parent/child link is
	 * made in the {@link ModelBuilder#nodeCompleted} method instead.
	 *
	 * @param parent
	 * @param child
	 */
	@Override
	protected void setParent(Object parent, Object child) {
		builder.setParent(castToModel(parent), castToModel(child));
	}

}