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

Go to download
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 com.hfg.xml.XMLTag;

import java.util.ArrayList;
import java.util.Collection;
import java.util.EnumSet;
import java.util.List;

//------------------------------------------------------------------------------
/**
 * An XML-serializable string list setting.
 *
 * @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 StringListSetting extends ListSettingImpl implements Setting>
{
   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public StringListSetting(String inName)
   {
      super(inName);
   }

   //---------------------------------------------------------------------------
   public StringListSetting(String inName, Collection inValue)
   {
      super(inName, inValue);
   }

   //---------------------------------------------------------------------------
   public StringListSetting(String inName, EnumSet inValue)
   {
      this(inName);

      List value = null;
      if (inValue != null)
      {
         value = new ArrayList<>(inValue.size());
         for (Object obj : inValue)
         {
            value.add(obj.toString());
         }
      }

      setValue(value);
   }

   //---------------------------------------------------------------------------
   /**
    * Copy constructor.
    * @param inObj2 the StringListSetting to clone
    */
   public StringListSetting(StringListSetting inObj2)
   {
      this(inObj2.name(), inObj2.getValue() == null ? null : new ArrayList<>(inObj2.getValue()));
   }

   //---------------------------------------------------------------------------
   public StringListSetting(XMLTag inXMLTag)
   {
      super(inXMLTag);
   }

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

   //---------------------------------------------------------------------------
   public StringListSetting setValue(List inValue)
   {
      super.setObjectValue(inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   public StringListSetting addValue(String inValue)
   {
      addValueFromString(inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   @Override
   public List getValue()
   {
      return (List) super.getObjectValue();
   }

   //---------------------------------------------------------------------------
   @Override
   public StringListSetting clone()
   {
      return new StringListSetting(this);
   }

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

   //---------------------------------------------------------------------------
   @Override
   protected void addValueFromString(String inValue)
   {
      List list = (List) getObjectValue();
      if (null == list)
      {
         list = new ArrayList(25);
         setObjectValue(list);
      }

      list.add(inValue);
   }

}