View Javadoc
   /*
    * ModuleCfgImpl.java
    * Created on August 16, 2003
    *
    * The Blues Framework - A lightweight application framework
    * Copyright (C) 2003  Lonnie Pryor
    * http://blues.lonniepryor.com
    *
    * This library is free software; you can redistribute it and/or modify it under the
   * terms of the GNU Lesser General Public License as published by the Free Software
   * Foundation; either version 2.1 of the License, or (at your option) any later
   * version.
   *
   * This library 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 Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public License along
   * with this library; if not, write to:
   *
   *   The Free Software Foundation, Inc.
   *   59 Temple Place, Suite 330
   *   Boston, MA 02111-1307 USA
   *
   */
  package com.lonniepryor.blues.cfg;
  
  import java.util.HashSet;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Set;
  
  /***
   * Generic implementation of {@link ModuleCfg}.
   *
   * @author Lonnie Pryor
   * @version $Revision: 1.1 $
   */
  public class ModuleCfgImpl implements ModuleCfg {
    /*** All of the element names declared in this module. */
    private final Set allNames = new HashSet();
    /*** The variables declared in this module. */
    private final List variableNames = new LinkedList();
    /*** The pointcuts declared in this module. */
    private final List pointcutCfgs = new LinkedList();
    /*** The advices declared in this module. */
    private final List adviceCfgs = new LinkedList();
    /*** The services declared in this module. */
    private final List serviceCfgs = new LinkedList();
    /*** The includes declared in this module. */
    private final List includeCfgs = new LinkedList();
  
    /***
     * Creates a new ModuleCfgImpl object.
     */
    public ModuleCfgImpl () {
    }
  
    /***
     * Declares a variable in this module.
     *
     * @param variable The variable to declare.
     */
    public void declareVariable (VariableCfg variable) {
      if (variable == null)
        throw new NullPointerException("Variable config cannot be null");
      indexName(variable.getName());
      variableNames.add(variable.getName());
    }
  
    /***
     * Declares a pointcut config in this module.
     *
     * @param pointcut The pointcut to declare.
     */
    public void declarePointcut (PointcutCfgImpl pointcut) {
      declare(pointcut);
    }
  
    /***
     * Declares an advice in this module.
     *
     * @param advice The advice to declare.
     */
    public void declareAdvice (AdviceCfgImpl advice) {
      declare(advice);
    }
  
    /***
     * Declares a service in this module.
     *
     * @param service The service to declare.
     */
    public void declareService (ServiceCfgImpl service) {
      declare(service);
    }
  
    /***
     * Declares an include in this module.
    *
    * @param include The include to declare.
    */
   public void declareIncludeModule (IncludeCfgImpl include) {
     declare(include);
   }
 
   /***
    * Declares a pointcut config in this module.
    *
    * @param pointcut The pointcut to declare.
    */
   public void declare (PointcutCfg pointcut) {
     if (pointcut == null)
       throw new NullPointerException("Pointcut config cannot be null");
     indexName(pointcut.getName());
     pointcutCfgs.add(pointcut);
   }
 
   /***
    * Declares an advice config in this module.
    *
    * @param advice The advice to declare.
    */
   public void declare (AdviceCfg advice) {
     if (advice == null)
       throw new NullPointerException("Advice config cannot be null");
     adviceCfgs.add(advice);
   }
 
   /***
    * Declares a service config in this module.
    *
    * @param service The service to declare.
    */
   public void declare (ServiceCfg service) {
     if (service == null)
       throw new NullPointerException("Service config cannot be null");
     indexName(service.getName());
     serviceCfgs.add(service);
   }
 
   /***
    * Declares an include config in this module.
    *
    * @param include The include to declare.
    */
   public void declare (IncludeCfg include) {
     if (include == null)
       throw new NullPointerException("Include config cannot be null");
     indexName(include.getName());
     includeCfgs.add(include);
   }
 
   /***
    * Indexes the specified name in this module's index, failing if it is already
    * declared.
    *
    * @param name The name to index.
    */
   private void indexName (String name) {
     if (!allNames.add(name))
       throw new IllegalArgumentException(
         "Cannot declare more than one element with name '" + name + "'");
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.ModuleCfg#getVariables()
    */
   public String[] getVariables () {
     return (String[])variableNames.toArray(new String[variableNames.size()]);
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.ModuleCfg#getDeclaredPointcuts()
    */
   public PointcutCfg[] getPointcuts () {
     return (PointcutCfg[])pointcutCfgs.toArray(
       new PointcutCfg[pointcutCfgs.size()]);
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.ModuleCfg#getDeclaredAdvice()
    */
   public AdviceCfg[] getAdvices () {
     return (AdviceCfg[])adviceCfgs.toArray(new AdviceCfg[adviceCfgs.size()]);
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.ModuleCfg#getDeclaredServices()
    */
   public ServiceCfg[] getServices () {
     return (ServiceCfg[])serviceCfgs.toArray(new ServiceCfg[serviceCfgs.size()]);
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.ModuleCfg#getIncludes()
    */
   public IncludeCfg[] getIncludes () {
     return (IncludeCfg[])includeCfgs.toArray(new IncludeCfg[includeCfgs.size()]);
   }
 
   /***
    * Child element for declaring external variables.
    *
    * @author Lonnie Pryor
    * @version $Revision: 1.1 $
    */
   public static class VariableCfg implements Verifiable {
     /*** The name of the external variable. */
     private String name = null;
 
     /***
      * Creates a new VariableCfg object.
      */
     public VariableCfg () {
     }
 
     /***
      * Sets the name of the external variable.
      *
      * @param name The name of the external variable.
      */
     public void setName (String name) {
       this.name = name;
     }
 
     /* (non-Javadoc)
      * @see com.lonniepryor.blues.cfg.Verifiable#verify()
      */
     public void verify () {
       if (name == null)
         throw new IllegalStateException("No variable name specified");
       if (name.length() == 0)
         throw new IllegalStateException("Empty variable name");
     }
 
     /***
      * Returns the name of the external variable.
      *
      * @return The name of the external variable.
      */
     public String getName () {
       return name;
     }
   }
 }