com.hfg.setting.Settings Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.setting;

import java.lang.reflect.Constructor;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.hfg.exception.ProgrammingException;
import com.hfg.util.collection.OrderedMap;
import com.hfg.util.StringUtil;
import com.hfg.xml.XMLName;
import com.hfg.xml.XMLTag;

//------------------------------------------------------------------------------
/**
 * A collection of XML-serializable settings.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// 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
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class Settings implements Cloneable
{
   private String mName;
   private XMLName mTagName = SettingXML.SETTINGS;

   private Map mSettingMap = new OrderedMap<>(25);

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public Settings()
   {
      init();
   }

   //---------------------------------------------------------------------------
   public Settings(XMLTag inXMLTag)
   {
      this();

      inXMLTag.verifyTagName(mTagName);

      setName(inXMLTag.getAttributeValue(SettingXML.NAME_ATT));

      List subtags = inXMLTag.getSubtags();
      if (subtags != null)
      {
         for (XMLTag subtag : subtags)
         {
            String classname = subtag.getAttributeValue(SettingXML.TYPE_ATT);
            if (StringUtil.isSet(classname))
            {
               try
               {
                  Class clazz = Class.forName(classname);
                  Constructor constructor = clazz.getConstructor(XMLTag.class);
                  add((Setting) constructor.newInstance(subtag));
               }
               catch (Exception e)
               {
                  throw new RuntimeException("Problem extracting setting!", e);
               }
            }
         }
      }
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   @Override
   public Settings clone()
   {
      Settings cloneObj = null;
      try
      {
         cloneObj = (Settings) super.clone();
      }
      catch (CloneNotSupportedException e)
      {
         throw new ProgrammingException(e);
      }

      cloneObj.mSettingMap = new HashMap<>(mSettingMap.size());
      for (String settingKey : mSettingMap.keySet())
      {
         cloneObj.mSettingMap.put(settingKey, mSettingMap.get(settingKey).clone());
      }

      return cloneObj;
   }

   //---------------------------------------------------------------------------
   public int size()
   {
      return mSettingMap.size();
   }

   //---------------------------------------------------------------------------
   public XMLTag toXMLTag()
   {
      XMLTag tag = new XMLTag(SettingXML.SETTINGS);

      if (StringUtil.isSet(mName))
      {
         tag.setAttribute(SettingXML.NAME_ATT, mName);
      }

      for (Setting setting : mSettingMap.values())
      {
         tag.addSubtag(setting.toXMLTag());
      }

      return tag;
   }

   //---------------------------------------------------------------------------
   public Settings add(Setting inValue)
   {
      mSettingMap.put(inValue.name(), inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   public Setting get(String inName)
   {
      return mSettingMap.get(inName);
   }

   //---------------------------------------------------------------------------
   public Settings setName(String inName)
   {
      mName = inName;
      return this;
   }

   //---------------------------------------------------------------------------
   public String name()
   {
      return mName;
   }

   //---------------------------------------------------------------------------
   public Settings setTagName(XMLName inName)
   {
      mTagName = inName;
      return this;
   }

   //###########################################################################
   // PROTECTED METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   /**
    For subclasses to override.
    */
   protected void init()
   {

   }

   //---------------------------------------------------------------------------
   protected Collection getSettingList()
   {
      return mSettingMap.values();
   }
}