com.alee.managers.settings.SettingsGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-core Show documentation
Core components for WebLaf
There is a newer version: 2.2.1
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.managers.settings;

import com.alee.utils.TextUtils;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamConverter;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

/**
 * Settings group data class.
 *
 * @author Mikle Garin
 * @see How to use SettingsManager
 * @see com.alee.managers.settings.SettingsManager
 */

@XStreamAlias ("SettingsGroup")
@XStreamConverter (SettingsConverter.class)
public class SettingsGroup implements Serializable
{
    /**
     * ID prefix.
     */
    private static final String ID_PREFIX = "SG";

    /**
     * Unique ID.
     */
    private String id;

    /**
     * Unique name.
     */
    private String name;

    /**
     * Settings map.
     */
    private Map settings;

    /**
     * Constructs unnamed SettingsGroup.
     */
    public SettingsGroup ()
    {
        this ( null );
    }

    /**
     * Constructs SettingsGroup with the specified name.
     *
     * @param name SettingsGroup name
     */
    public SettingsGroup ( final String name )
    {
        super ();
        this.id = TextUtils.generateId ( ID_PREFIX );
        this.name = name;
    }

    /**
     * Constructs SettingsGroup with the specified name.
     *
     * @param id   SettingsGroup ID
     * @param name SettingsGroup name
     */
    public SettingsGroup ( final String id, final String name )
    {
        super ();
        this.id = id;
        this.name = name;
    }

    /**
     * Returns SettingsGroup unique ID.
     *
     * @return SettingsGroup unique ID
     */
    public String getId ()
    {
        return id;
    }

    /**
     * Sets unique ID.
     *
     * @param id new unique ID
     */
    public void setId ( final String id )
    {
        this.id = id;
    }

    /**
     * Returns unique name.
     *
     * @return unique name
     */
    public String getName ()
    {
        return name;
    }

    /**
     * Sets unique name.
     *
     * @param name new unique name
     */
    public void setName ( final String name )
    {
        this.name = name;
    }

    /**
     * Returns settings map.
     *
     * @return settings map
     */
    public Map getSettings ()
    {
        if ( settings == null )
        {
            settings = new HashMap ();
        }
        return settings;
    }

    /**
     * Sets settings map.
     *
     * @param settings new settings map
     */
    public void setSettings ( final Map settings )
    {
        this.settings = settings;
    }

    /**
     * Returns value for specified key.
     *
     * @param key key
     * @return value for specified key
     */
    public Object get ( final String key )
    {
        return getSettings ().get ( key );
    }

    /**
     * Removes settings saved under the specified key.
     *
     * @param key settings key
     * @return settings previously saved under the specified key
     */
    public Object remove ( final String key )
    {
        return getSettings ().remove ( key );
    }

    /**
     * Puts value under the specified key.
     *
     * @param key    key
     * @param object value
     * @param     value type
     * @return previous value for the specified key
     */
    public  T put ( final String key, final T object )
    {
        return ( T ) getSettings ().put ( key, object );
    }
}