it.unibo.alchemist.model.Deployment Maven / Gradle / Ivy

Go to download

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

Alchemist Machinery to load from files

The 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;

import javax.annotation.Nullable;
import java.util.Iterator;
import java.util.stream.Stream;

/**
 * @param  position type
 */
@FunctionalInterface
public interface Deployment
> extends Iterable
 {

    /**
     * @return a {@link Stream} over the positions of this {@link Deployment}
     */
    Stream
 stream();

    @Override
    default Iterator iterator() {
        return stream().iterator();
    }

    /**
     * Optional {@link LinkingRule} associated to the deployment.
     *
     * @param  concentration type of the {@link LinkingRule}
     * @return null if the deployment has no associated {@link LinkingRule},
     * and an instance of the {@link LinkingRule} otherwise
     */
    @Nullable
    default  LinkingRule getAssociatedLinkingRule() {
        return null;
    }
}