io.patriot_framework.network.simulator.api.builder.RouterBuilder Maven / Gradle / Ivy

/*
 * Copyright 2019 Patriot project
 *
 *    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 io.patriot_framework.network.simulator.api.builder;

import io.patriot_framework.network.simulator.api.model.devices.router.Router;
import io.patriot_framework.network.simulator.api.model.devices.router.RouterImpl;

/**
 * The type RouterImpl builder.
 */
public class RouterBuilder {

    public RouterBuilder(String name) {
        this.name = name;
    }

    /**
     * The Topology builder.
     */
    private TopologyBuilder topologyBuilder;
    /**
     * Name of router.
     */
    private String name;

    /**
     * Creator of object (docker, VM, ...)
     */
    private String creator;

    private Boolean corner = false;

    /**
     * Instantiates a new RouterImpl builder.
     *
     * @param topologyBuilder the topology builder
     */
    public RouterBuilder(TopologyBuilder topologyBuilder) {
        this.topologyBuilder = topologyBuilder;
    }

    /**
     * Adds name to router.
     *
     * @param name the name
     * @return the router builder
     */
    public RouterBuilder withName(String name) {
        this.name = name;
        return this;
    }

    public RouterBuilder withCreator(String creator) {
        this.creator = creator;
        return this;
    }

    public RouterBuilder withCorner(Boolean corner) {
        this.corner = corner;
        return this;
    }

    /**
     * Create new router object and add it into topology routers.
     *
     * @return the router builder
     */
    public RouterBuilder createRouter() {
        if (creator == null) {
            creator = topologyBuilder.getCurrentCreator();
        }
        topologyBuilder.getTopology().getRouters().add(new RouterImpl(name, creator, corner));
        return this;
    }

    /**
     * Returns TopologyBuilder with created routers.
     *
     * @return the topology builder
     */
    public TopologyBuilder addRouters() {
        return topologyBuilder;
    }

    public Router build() {
        RouterImpl router = new RouterImpl(name, creator, corner);
        return router;
    }

}