com.farao_community.farao.data.crac_impl.AbstractIdentifiableAdder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of farao-crac-impl Show documentation

Object model for CRAC implementation

There is a newer version: 5.0.0

/*
 * Copyright (c) 2020, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

package com.farao_community.farao.data.crac_impl;

import com.farao_community.farao.commons.FaraoException;
import com.farao_community.farao.data.crac_api.IdentifiableAdder;

/**
 * @author Peter Mitri {@literal }
 */
public abstract class AbstractIdentifiableAdder> {

    protected String id;
    protected String name;

    protected abstract String getTypeDescription();

    protected void checkId() {
        if (this.id == null) {
            throw new FaraoException(String.format("Cannot add a %s object with no specified id. Please use withId()", getTypeDescription()));
        } else if (this.name == null) {
            this.name = this.id;
        }
    }

    /**
     * Set the ID of the identifiable to add
     * @param id: ID to set
     * @return the identifiable adder instance
     */
    public T withId(String id) {
        this.id = id;
        return (T) this;
    }

    /**
     * Set the name of the identifiable to add
     * @param name: NAME to set
     * @return the identifiable adder instance
     */
    public T withName(String name) {
        this.name = name;
        return (T) this;
    }

}