org.apache.juneau.rest.client.NameValuePairs Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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.apache.juneau.rest.client;
import static org.apache.juneau.internal.StringUtils.*;
import java.util.*;
import org.apache.http.*;
import org.apache.http.client.entity.*;
import org.apache.http.message.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.oapi.*;
import org.apache.juneau.urlencoding.*;
/**
* Convenience class for constructing instances of List<NameValuePair> for the
* {@link UrlEncodedFormEntity} class.
*
*
* Instances of this method can be passed directly to the {@link RestClient#doPost(Object, Object)} method or
* {@link RestCall#body(Object)} methods to perform URL-encoded form posts.
*
*
Example:
*
* NameValuePairs params = new NameValuePairs()
* .append("j_username" , user)
* .append("j_password" , pw);
* restClient.doPost(url, params).run();
*
*/
public final class NameValuePairs extends LinkedList {
private static final long serialVersionUID = 1L;
/**
* Appends the specified pair to the end of this list.
*
* @param pair The pair to append to this list.
* @return This object (for method chaining).
*/
public NameValuePairs append(NameValuePair pair) {
super.add(pair);
return this;
}
/**
* Appends the specified name/value pair to the end of this list.
*
*
* The value is simply converted to a string using toString(), or "null" if null .
*
* @param name The pair name.
* @param value The pair value.
* @return This object (for method chaining).
*/
public NameValuePairs append(String name, Object value) {
super.add(new BasicNameValuePair(name, asString(value)));
return this;
}
/**
* Appends the specified name/value pair to the end of this list.
*
*
* The value is converted to UON notation using the {@link UrlEncodingSerializer} defined on the client.
*
* @param name The pair name.
* @param value The pair value.
* @param serializer
* The serializer to use for serializing the value to a string value.
* @param schema
* The schema object that defines the format of the output.
*
If null , defaults to the schema defined on the parser.
*
If that's also null , defaults to {@link HttpPartSchema#DEFAULT}.
*
Only used if serializer is schema-aware (e.g. {@link OpenApiSerializer}).
* @return This object (for method chaining).
*/
public NameValuePairs append(String name, Object value, HttpPartSerializer serializer, HttpPartSchema schema) {
super.add(new SerializedNameValuePair(name, value, serializer, schema));
return this;
}
}