ScopedMacroDefinition.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.ant.platform.core;

import org.ant4eclipse.lib.core.Assure;
import org.apache.tools.ant.taskdefs.MacroDef;

/**
 * <p>
 * Associates a ant {@link MacroDef} with a scope.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 * 
 * @param <E>
 *          the scope type
 */
public class ScopedMacroDefinition<E> {

  /** the macro definition */
  private MacroDef _macroDef;

  /** the scope of the macro definition */
  private E        _scope;

  /**
   * <p>
   * Creates a new instance of type {@link ScopedMacroDefinition}.
   * </p>
   * 
   * @param macroDefinition
   * @param scope
   */
  public ScopedMacroDefinition(MacroDef macroDefinition, E scope) {
    Assure.notNull("macroDefinition", macroDefinition);
    Assure.notNull("scope", scope);
    this._macroDef = macroDefinition;
    this._scope = scope;
  }

  /**
   * <p>
   * Returns the macro definition.
   * </p>
   * 
   * @return the macro definition.
   */
  public MacroDef getMacroDef() {
    return this._macroDef;
  }

  /**
   * <p>
   * Returns the scope.
   * </p>
   * 
   * @return the scope.
   */
  public E getScope() {
    return this._scope;
  }
}