/*
 * Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 3 of the License, or (at your option)
 * any later version.
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see http://www.gnu.org/licenses/
 */

package com.bc.ceres.core.runtime;

/**
 * An dependency declared in a module.
 * <p/>
 * <p>If {@link #getDeclaringModule() declared} in a module manifest (module.xml), a dependency has the following syntax:
 * <pre>
 *    <dependency>
 *        <module>{@link #getModuleSymbolicName() moduleId}</module>
 *        <version>{@link #getVersion() version}</version>
 *    </dependency>
 * </pre>
 * </p>
 * <p/>
 * Or for libraries:
 * <pre>
 *    <dependency>
 *        <lib>{@link #getLibName() libName}</lib>
 *        <version>{@link #getVersion() version}</version>
 *    </dependency>
 * </pre>
 * <p/>
 * This interface is not intended to be implemented by clients.</p>
 */
public interface Dependency {

    Module getDeclaringModule();

    String getLibName();

    String getModuleSymbolicName();

    String getVersion();

    boolean isOptional();
}