View Javadoc
   /*
    * IncludeCfgImpl.java
    * Created on September 19, 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.HashMap;
  import java.util.Map;
  
  /***
   * Generic implementation of {@link IncludeCfg}.
   *
   * @author Lonnie Pryor
   * @version $Revision: 1.1 $
   */
  public class IncludeCfgImpl implements IncludeCfg, Verifiable {
    /*** The name given to the module to include. */
    private String name = null;
    /*** The path to the module configuration. */
    private String modulePath = null;
    /*** The included module. */
    private ModuleCfg module = null;
    /*** The variable refrences set on the included module. */
    private final Map variableRefrences = new HashMap();
  
    /***
     * Creates a new IncludeCfgImpl object.
     */
    public IncludeCfgImpl () {
    }
  
    /***
     * Sets the name given to the module to include.
     *
     * @param name The name given to the module to include.
     */
    public void setName (String name) {
      this.name = name;
    }
  
    /***
     * Sets the path to the module configuration.
     *
     * @param modulePath The path to the module configuration.
     */
    public void setPath (String modulePath) {
      this.modulePath = modulePath;
    }
  
    /***
     * Declares a variable name/refrence pair on this include.
     *
     * @param variable The variable configuration.
     */
    public void declareSetVariable (SetVariableCfg variable) {
      if (variable == null)
        throw new NullPointerException("Set variable config cannot be null");
      if (variableRefrences.containsKey(variable.getName()))
        throw new IllegalArgumentException(
          "Cannot set the variable '" + variable.getName() + "' more than once");
      variableRefrences.put(variable.getName(), variable.getRef());
    }
  
    /* (non-Javadoc)
     * @see com.lonniepryor.blues.cfg.Verifiable#verify()
     */
    public void verify () {
      if (name == null)
        throw new IllegalStateException("No include name specified");
      if (name.length() == 0)
        throw new IllegalStateException("Empty include name");
      if (modulePath == null)
        throw new IllegalStateException("No include module path specified");
      if (modulePath.length() == 0)
        throw new IllegalStateException("Empty include module path");
    }
  
    /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.IncludeCfg#getName()
    */
   public String getName () {
     return name;
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.IncludeCfg#getModulePath()
    */
   public String getModulePath () {
     return modulePath;
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.IncludeCfg#getVariableNames()
    */
   public String[] getVariableNames () {
     return (String[])variableRefrences.keySet().toArray(
       new String[variableRefrences.size()]);
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.IncludeCfg#getVariableRefrence(java.lang.String)
    */
   public String getVariableRefrence (String variableName) {
     return (String)variableRefrences.get(variableName);
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.IncludeCfg#initIncludedModule(
    *   com.lonniepryor.blues.cfg.ModuleCfg)
    */
   public void initIncludedModule (ModuleCfg module) {
     if (module == null)
       throw new NullPointerException("Included module cannot be null");
     if (this.module != null)
       throw new IllegalStateException("Included module already initalized");
     this.module = module;
   }
 
   /* (non-Javadoc)
    * @see com.lonniepryor.blues.cfg.IncludeCfg#getIncludedModule()
    */
   public ModuleCfg getIncludedModule () {
     if (module == null)
       throw new IllegalStateException("Included module not initalized");
     return module;
   }
 
   /***
    * Child element for setting variable refrences.
    *
    * @author Lonnie Pryor
    * @version $Revision: 1.1 $
    */
   public static class SetVariableCfg implements Verifiable {
     /*** The name of the variable to set. */
     private String name = null;
     /*** The refrence to set the variable to. */
     private String ref = null;
 
     /***
      * Creates a new SetVariableCfg object.
      */
     public SetVariableCfg () {
     }
 
     /***
      * Sets the name of the variable to set.
      *
      * @param name The name of the variable to set.
      */
     public void setName (String name) {
       this.name = name;
     }
 
     /***
      * Sets the refrence to set the variable to.
      *
      * @param ref The refrence to set the variable to.
      */
     public void setRef (String ref) {
       this.ref = ref;
     }
 
     /* (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");
       if (ref == null)
         throw new IllegalStateException("No variable refrence specified");
       if (ref.length() == 0)
         throw new IllegalStateException("Empty variable refrence");
     }
 
     /***
      * Returns the name of the variable to set.
      *
      * @return The name of the variable to set.
      */
     public String getName () {
       return name;
     }
 
     /***
      * Returns the refrence to set the variable to.
      *
      * @return The refrence to set the variable to.
      */
     public String getRef () {
       return ref;
     }
   }
 }