it.unibo.alchemist.model.conditions.AbstractCondition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-implementationbase Show documentation

Abstract, incarnation independent implementations of the Alchemist's interfaces. Provides support for those who want to write incarnations.

There is a newer version: 35.0.1

Show newest version

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.model.conditions;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import it.unibo.alchemist.model.Condition;
import it.unibo.alchemist.model.Dependency;
import it.unibo.alchemist.model.Node;
import it.unibo.alchemist.model.Reaction;
import org.danilopianini.util.LinkedListSet;
import org.danilopianini.util.ListSet;
import org.danilopianini.util.ListSets;

import javax.annotation.Nonnull;
import java.util.Objects;


/**
 *
 * @param  concentration type
 */
public abstract class AbstractCondition implements Condition {

    private static final long serialVersionUID = -1610947908159507754L;
    private final ListSet influencing = new LinkedListSet<>();
    private final Node node;

    /**
     * @param node the node this Condition belongs to
     */
    @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "This is intentional")
    public AbstractCondition(@Nonnull final Node node) {
        this.node = Objects.requireNonNull(node);
    }

    /**
     * {@inheritDoc}
     * 
     * How to override: if you intend your condition to be potentially changed by
     * any change in the context, return null.
     */
    @Override
    public final ListSet getInboundDependencies() {
        return ListSets.unmodifiableListSet(influencing);
    }

    /**
     * {@inheritDoc}
     * 
     * Override if your {@link Condition} can return a more specific type of node.
     * The typical way is to cast the call to super.getNode().
     */
    @Override
    @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "It is intentional")
    public Node getNode() {
        return node;
    }

    /**
     * @param m the molecule to add
     */
    protected final void declareDependencyOn(final Dependency m) {
        influencing.add(m);
    }

    /**
     * {@inheritDoc}
     * 
     * How to override: create a new action of your concrete subtype.
     */
    @Override
    public Condition cloneCondition(final Node node, final Reaction reaction) {
        throw new UnsupportedOperationException(getClass().getSimpleName() + " has no support for cloning.");
    }

    /**
     *
     * @return the simple class name
     */
    @Override
    public String toString() {
        return getClass().getSimpleName();
    }
}