ClassPathElementsRegistry.java

/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich
 **********************************************************************/
package org.ant4eclipse.lib.jdt.tools.classpathelements;

import org.ant4eclipse.lib.jdt.tools.container.ClasspathContainerResolver;

import java.io.File;
import java.util.List;
import java.util.Map;

/**
 * <p>
 * The {@link ClassPathElementsRegistry} allows to register class path container and variables. Please be aware that
 * this registry takes care of conflicting names.
 * </p>
 * <p>
 * This interface is <b>not</b> intended to be implemented by clients.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface ClassPathElementsRegistry {

  /**
   * <p>
   * Registers a new class path container with the given name.
   * </p>
   * <p>
   * <b>Note:</b> Registering class path containers manually should be used as the last resort to define class path
   * containers. Take a look at the {@link ClasspathContainerResolver} interface for more information about how to
   * implement 'dynamic' container resolver.
   * </p>
   * 
   * @param name
   * @param pathEntries
   */
  void registerClassPathContainer(String name, File[] pathEntries);

  /**
   * <p>
   * Returns <code>true</code> if a class path container with the given name exists.
   * </p>
   * <p>
   * <b>Note:</b> Registering class path containers manually should be used as the last resort to define class path
   * containers. Take a look at the {@link ClasspathContainerResolver} interface for more information about how to
   * implement 'dynamic' container resolver.
   * </p>
   * 
   * @param name
   *          <code>true</code> if a class path container with the given name exists.
   */
  boolean hasClassPathContainer(String name);

  /**
   * <p>
   * Returns the class path container with the given name or <code>null</code>.
   * </p>
   * <p>
   * <b>Note:</b> Registering class path containers manually should be used as the last resort to define class path
   * containers. Take a look at the {@link ClasspathContainerResolver} interface for more information about how to
   * implement 'dynamic' container resolver.
   * </p>
   * 
   * @param name
   * @return
   */
  ClassPathContainer getClassPathContainer(String name);

  /**
   * <p>
   * Returns a list with all defined class path containers.
   * </p>
   * <p>
   * <b>Note:</b> Registering class path containers manually should be used as the last resort to define class path
   * containers. Take a look at the {@link ClasspathContainerResolver} interface for more information about how to
   * implement 'dynamic' container resolver.
   * </p>
   * 
   * @return a list with all defined class path containers.
   */
  List<ClassPathContainer> getClasspathContainer();

  /**
   * <p>
   * Registers a new class path variable with the given name.
   * </p>
   * 
   * @param name
   *          the name of the class path variable.
   * @param path
   *          the path
   */
  void registerClassPathVariable(String name, File path);

  /**
   * <p>
   * Registers a list of class path variables.
   * </p>
   * 
   * @param vars
   *          a map representing the class path variables. Not <code>null</code>.
   */
  void registerClassPathVariables(Map<String, File> vars);

  /**
   * <p>
   * Returns <code>true</code> if a class path variable with the given name exists.
   * </p>
   * 
   * @param name
   *          the name of the class path variable.
   * @return <code>true</code> if a class path variable with the given name exists.
   */
  boolean hasClassPathVariable(String name);

  /**
   * <p>
   * Returns the class path variable with the given name or <code>null</code>.
   * </p>
   * 
   * @param name
   *          the name of the class path variable.
   * @return the class path variable with the given name or <code>null</code>.
   */
  ClassPathVariable getClassPathVariable(String name);

  /**
   * <p>
   * Returns a list with all defined class path variables.
   * </p>
   * 
   * @return a list with all defined class path variables.
   */
  List<ClassPathVariable> getClasspathVariables();

}