Open Source Repository

Home /spring/spring-test-3.0.5 | Repository Home


org/springframework/mock/web/portlet/MockPortletPreferences.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.mock.web.portlet;

import java.io.IOException;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import javax.portlet.PortletPreferences;
import javax.portlet.PreferencesValidator;
import javax.portlet.ReadOnlyException;
import javax.portlet.ValidatorException;

import org.springframework.util.Assert;

/**
 * Mock implementation of the {@link javax.portlet.PortletPreferences} interface.
 *
 @author John A. Lewis
 @author Juergen Hoeller
 @since 2.0
 */
public class MockPortletPreferences implements PortletPreferences {

  private PreferencesValidator preferencesValidator;

  private final Map<String, String[]> preferences = new LinkedHashMap<String, String[]>();

  private final Set<String> readOnly = new HashSet<String>();


  public void setReadOnly(String key, boolean readOnly) {
    Assert.notNull(key, "Key must not be null");
    if (readOnly) {
      this.readOnly.add(key);
    }
    else {
      this.readOnly.remove(key);
    }
  }

  public boolean isReadOnly(String key) {
    Assert.notNull(key, "Key must not be null");
    return this.readOnly.contains(key);
  }

  public String getValue(String key, String def) {
    Assert.notNull(key, "Key must not be null");
    String[] values = this.preferences.get(key);
    return (values != null && values.length > ? values[0: def);
  }

  public String[] getValues(String key, String[] def) {
    Assert.notNull(key, "Key must not be null");
    String[] values = this.preferences.get(key);
    return (values != null && values.length > ? values : def);
  }

  public void setValue(String key, String valuethrows ReadOnlyException {
    setValues(key, new String[] {value});
  }

  public void setValues(String key, String[] valuesthrows ReadOnlyException {
    Assert.notNull(key, "Key must not be null");
    if (isReadOnly(key)) {
      throw new ReadOnlyException("Preference '" + key + "' is read-only");
    }
    this.preferences.put(key, values);
  }

  public Enumeration<String> getNames() {
    return Collections.enumeration(this.preferences.keySet());
  }

  public Map<String, String[]> getMap() {
    return Collections.unmodifiableMap(this.preferences);
  }

  public void reset(String keythrows ReadOnlyException {
    Assert.notNull(key, "Key must not be null");
    if (isReadOnly(key)) {
      throw new ReadOnlyException("Preference '" + key + "' is read-only");
    }
    this.preferences.remove(key);
  }

  public void setPreferencesValidator(PreferencesValidator preferencesValidator) {
    this.preferencesValidator = preferencesValidator;
  }

  public void store() throws IOException, ValidatorException {
    if (this.preferencesValidator != null) {
      this.preferencesValidator.validate(this);
    }
  }

}