it.unibo.alchemist.model.interfaces.Molecule Maven / Gradle / Ivy

Go to download

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

Interfaces of core and model components of Alchemist

There is a newer version: 20.0.1

/*
 * Copyright (C) 2010-2014, Danilo Pianini and contributors
 * listed in the project's pom.xml 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.interfaces;

import java.io.Serializable;

/**
 *          Interface for a molecule.
 * 
 */
public interface Molecule extends Serializable {

    /**
     * @return the name of this {@link Molecule}
     */
    String getName();

    /**
     * Allows to access the id of a molecule.
     * 
     * @return the id of the molecule
     */
    long getId();

    /**
     * Calculates the dependency of an {@link Molecule} against another.
     * 
     * @param mol the molecole to verify the dependency
     * @return true if this molecule generates a dependency with mol
     */
    boolean dependsOn(Molecule mol);

}