javax.ws.rs.core.Form Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation
Show all versions of ehcache Show documentation
Ehcache is an open source, standards-based cache used to boost performance,
offload the database and simplify scalability. Ehcache is robust, proven and full-featured and
this has made it the most widely-used Java-based cache.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.ws.rs.core;
import java.util.LinkedHashMap;
import java.util.List;
/**
* Represents the the HTML form data request entity encoded using the
* {@code "application/x-www-form-urlencoded"} content type.
*
* @author Marek Potociar
* @since 2.0
*/
public class Form {
private final MultivaluedMap parameters;
/**
* Create a new form data instance.
*
* The underlying form parameter store is configured to preserve the insertion order
* of the parameters. I.e. parameters can be iterated in the same order as they were
* inserted into the {@code Form}.
*
*/
public Form() {
this(new AbstractMultivaluedMap(new LinkedHashMap>()) {
// by default, the items in a Form are iterable based on their insertion order.
});
}
/**
* Create a new form data instance with a single parameter entry.
*
* The underlying form parameter store is configured to preserve the insertion order
* of the parameters. I.e. parameters can be iterated in the same order as they were
* inserted into the {@code Form}.
*
*
* @param parameterName form parameter name.
* @param parameterValue form parameter value.
*/
public Form(final String parameterName, final String parameterValue) {
this();
parameters.add(parameterName, parameterValue);
}
/**
* Create a new form data instance and register a custom underlying parameter store.
*
* This method is useful in situations when a custom parameter store is needed
* in order to change the default parameter iteration order, improve performance
* or facilitate other custom requirements placed on the parameter store.
*
*
* @param store form data store used by the created form instance.
*/
public Form(final MultivaluedMap store) {
this.parameters = store;
}
/**
* Adds a new value to the specified form parameter.
*
* @param name name of the parameter.
* @param value new parameter value to be added.
* @return updated {@code Form} instance.
*/
public Form param(final String name, final String value) {
parameters.add(name, value);
return this;
}
/**
* Returns multivalued map representation of the form.
*
* @return form represented as multivalued map.
* @see MultivaluedMap
*/
public MultivaluedMap asMap() {
return parameters;
}
}