com.varmateo.yawg.spi.TemplateContextBuilder Maven / Gradle / Ivy

Go to download
/**************************************************************************
 *
 * Copyright (c) 2017-2020 Yawg project contributors.
 *
 **************************************************************************/

package com.varmateo.yawg.spi;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

import com.varmateo.yawg.spi.TemplateContext.Author;


/**
 * Builder of TemplateContext instances.
 */
public final class TemplateContextBuilder {


    private List _authors;
    private String _body;
    private String _pageUrl;
    private String _rootRelativeUrl;
    private PageVars _pageVars;
    private String _title;
    private String _bakeId;


    /**
     *
     */
    private TemplateContextBuilder() {

        _authors = new ArrayList<>();
        _body = null;
        _pageUrl = null;
        _rootRelativeUrl = null;
        _pageVars = PageVars.empty();
        _title = null;
        _bakeId = null;
    }


    /**
     * Creates a new empty builder.
     *
     * @return A newly created TemplateContextBuilder
     * instance.
     */
    public static TemplateContextBuilder create() {

        return new TemplateContextBuilder();
    }


    /**
     *
     */
    public TemplateContextBuilder addAuthor(
            final String name,
            final String email) {

        final Author author = Author.create(name, email);
        _authors.add(author);
        return this;
    }


    /**
     *
     */
    public TemplateContextBuilder body(final String body) {

        _body = Objects.requireNonNull(body);
        return this;
    }


    /**
     *
     */
    public TemplateContextBuilder pageUrl(final String pageUrl) {

        _pageUrl = pageUrl;
        return this;
    }


    /**
     *
     */
    public TemplateContextBuilder rootRelativeUrl(
            final String rootRelativeUrl) {

        _rootRelativeUrl = rootRelativeUrl;
        return this;
    }


    /**
     *
     */
    public TemplateContextBuilder pageVars(final PageVars pageVars) {

        _pageVars = pageVars;
        return this;
    }


    /**
     *
     */
    public TemplateContextBuilder title(final String title) {

        _title = Objects.requireNonNull(title);
        return this;
    }


    /**
     *
     */
    public TemplateContextBuilder bakeId(final String bakeId) {

        _bakeId = bakeId;
        return this;
    }


    /**
     *
     */
    public TemplateContext build() {

        return new TemplateContextImpl(this);
    }


    /**
     *
     */
    private static final class TemplateContextImpl
            implements TemplateContext {


        private final List _authors;
        private final String _body;
        private final String _pageUrl;
        private final PageVars _pageVars;
        private final String _rootRelativeUrl;
        private final String _title;
        private final String _bakeId;


        /**
         *
         */
        /* default */ TemplateContextImpl(final TemplateContextBuilder builder) {

            _authors = Collections.unmodifiableList(new ArrayList<>(builder._authors));
            _body = Objects.requireNonNull(builder._body);
            _pageUrl = Objects.requireNonNull(builder._pageUrl);
            _pageVars = Objects.requireNonNull(builder._pageVars);
            _rootRelativeUrl = Objects.requireNonNull(builder._rootRelativeUrl);
            _title = Objects.requireNonNull(builder._title);
            _bakeId = Objects.requireNonNull(builder._bakeId);
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public Iterable authors() {
            return _authors;
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public String body() {
            return _body;
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public String pageUrl() {
            return _pageUrl;
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public PageVars pageVars() {
            return _pageVars;
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public String rootRelativeUrl() {
            return _rootRelativeUrl;
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public String title() {
            return _title;
        }


        /**
         * {@inheritDoc}
         */
        @Override
        public String bakeId() {
            return _bakeId;
        }

    }

}