SgfProperties.java

// SgfProperties.java

package net.sf.gogui.game;

import java.util.ArrayList;
import java.util.Map;
import java.util.TreeMap;

/** Unknown SGF properties.
    Non-type-checked SGF properties for preserving unknown properties.
    Should only be used for unknown properties.
    @todo Iteration is inefficient, reimplement (but without sacrificing
    const-correctness) */
public final class SgfProperties
    implements ConstSgfProperties
{
    public SgfProperties()
    {
        m_properties = new TreeMap<String,ArrayList<String>>();
    }

    public SgfProperties(ConstSgfProperties props)
    {
        this();
        if (props == null)
            return;
        for (Map.Entry<String,ArrayList<String>> entry :
                 ((SgfProperties)props).m_properties.entrySet())
            add(entry.getKey(), entry.getValue());
    }

    public void add(String key, ArrayList<String> values)
    {
        m_properties.put(key, new ArrayList<String>(values));
    }

    public void add(String key, String value)
    {
        ArrayList<String> values = new ArrayList<String>();
        values.add(value);
        m_properties.put(key, values);
    }

    /** Get a list of all keys.
        This list is a copy of the keys at the time of the function call. */
    public ArrayList<String> getKeys()
    {
        return new ArrayList<String>(m_properties.keySet());
    }

    /** Return number of values for a key.
        @return Number of values or -1, if key does not exist. */
    public int getNumberValues(String key)
    {
        ArrayList<String> values = m_properties.get(key);
        if (values == null)
            return -1;
        return values.size();
    }

    public String getValue(String key, int index)
    {
        return m_properties.get(key).get(index);
    }

    public boolean hasKey(String key)
    {
        return (getNumberValues(key) >= 0);
    }

    public boolean isEmpty()
    {
        return (m_properties.size() == 0);
    }

    public void remove(String key)
    {
        m_properties.remove(key);
    }

    private Map<String,ArrayList<String>> m_properties;
}