juzu.impl.common.ParameterMap Maven / Gradle / Ivy
/*
* Copyright 2013 eXo Platform SAS
*
* 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 juzu.impl.common;
import java.util.Map;
/** @author Julien Viet */
public interface ParameterMap extends Map {
ParameterMap EMPTY = new EmptyParameterMap();
/**
* Set a parameter on the URL that will be built by this builder. This method replaces the parameter with the
* given name . A parameter value of null indicates that this parameter should be removed.
*
* @param name the parameter name
* @param value the parameter value
* @throws NullPointerException if the name parameter is null
*/
void setParameter(String name, String value) throws NullPointerException;
/**
* Set a parameter. This method replaces the parameter with the given name . An zero length parameter value indicates
* that this parameter should be removed.
*
* The inserted value is cloned before its insertion in the map.
*
* @param name the parameter name
* @param value the parameter value
* @throws NullPointerException if the name parameter or the value parameter is null
* @throws IllegalArgumentException if any component of the value is null
*/
void setParameter(String name, String[] value) throws NullPointerException, IllegalArgumentException;
/**
* Set all parameters contained in the map. This method replaces the parameter with the given name . A parameter
* value of with a zero length value array indicates that this parameter should be removed.
*
* Inserted values are cloned.
*
* @param parameters the parameters
* @throws NullPointerException if the parameters argument is null
* @throws IllegalArgumentException if any key, if any value in the map is null or contains a null element
*/
void setParameters(Map parameters) throws NullPointerException, IllegalArgumentException;
/**
* Redefines equals to implement equality on the String[] type.
*
* @see Map#equals(Object)
*/
boolean equals(Object o);
}