Portlet.java

/**
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.exoplatform.portal.pom.spi.portlet;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.gatein.mop.api.content.ContentType;

/**
 * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
 * @version $Revision$
 */
public final class Portlet implements Iterable<Preference>, Serializable {

    /** . */
    public static final ContentType<Portlet> CONTENT_TYPE = new ContentType<Portlet>("application/portlet", Portlet.class);

    /** . */
    final Map<String, Preference> state;

    /** . */
    private final Map<String, Preference> entries;

    public Portlet() {
        this.state = new HashMap<String, Preference>();
        this.entries = Collections.unmodifiableMap(this.state);
    }

    public Portlet(Map<String, Preference> state) {
        if (state == null) {
            throw new NullPointerException();
        }

        //
        this.state = new HashMap<String, Preference>(state);
        this.entries = Collections.unmodifiableMap(this.state);
    }

    public List<String> getValues(String name) {
        Preference entry = entries.get(name);
        return entry != null ? entry.getValues() : null;
    }

    public Portlet setValues(String name, List<String> values) {
        Preference entry = entries.get(name);
        if (entry == null) {
            entry = new Preference(name, values, false);
        } else {
            entry = new Preference(entry.getName(), values, entry.isReadOnly());
        }
        entries.put(name, entry);
        return this;
    }

    public String getValue(String name) {
        Preference entry = entries.get(name);
        return entry != null ? entry.getValue() : null;
    }

    public Portlet setValue(String name, String value) {
        Preference entry = entries.get(name);
        if (entry == null) {
            entry = new Preference(name, value, false);
        } else {
            entry = new Preference(entry.getName(), value, entry.isReadOnly());
        }
        state.put(name, entry);
        return this;
    }

    public Boolean isReadOnly(String name) {
        Preference entry = entries.get(name);
        return entry != null ? entry.isReadOnly() : null;
    }

    public Portlet setReadOnly(String name, boolean readOnly) {
        Preference entry = entries.get(name);
        if (entry == null) {
            throw new IllegalStateException();
        }
        entry = new Preference(entry.getName(), entry.getValues(), readOnly);
        state.put(name, entry);
        return this;
    }

    public Preference getPreference(String name) {
        return entries.get(name);
    }

    public Portlet putPreference(Preference preference) {
        state.put(preference.getName(), preference);
        return this;
    }

    public Iterator<Preference> iterator() {
        return entries.values().iterator();
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (obj instanceof Portlet) {
            Portlet that = (Portlet) obj;
            return state.equals(that.state);
        }
        return false;
    }

    @Override
    public int hashCode() {
        return state.hashCode();
    }

    @Override
    public String toString() {
        return "Preferences[state=" + state.toString() + "]";
    }
}