1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.net;
29
30 import java.nio.charset.Charset;
31 import java.util.List;
32
33 import org.apache.hc.core5.http.NameValuePair;
34
35 /**
36 * {@code application/x-www-form-urlencoded} codec.
37 *
38 * @since 5.1
39 */
40 public class WWWFormCodec {
41
42 /**
43 * Returns a list of {@link NameValuePair} parameters parsed
44 * from the {@code application/x-www-form-urlencoded} content.
45 *
46 * @param s input text.
47 * @param charset parameter charset.
48 * @return list of form parameters.
49 */
50 public static List<NameValuePair> parse(final CharSequence s, final Charset charset) {
51 return URIBuilder.parseQuery(s, charset, true);
52 }
53
54 /**
55 * Formats the list of {@link NameValuePair} parameters into a {@code application/x-www-form-urlencoded}
56 * content.
57 *
58 * @param buf the content buffer
59 * @param params The from parameters.
60 * @param charset The encoding to use.
61 */
62 public static void format(
63 final StringBuilder buf, final Iterable<? extends NameValuePair> params, final Charset charset) {
64 URIBuilder.formatQuery(buf, params, charset, true);
65 }
66
67 /**
68 * Formats the list of {@link NameValuePair} parameters into a {@code application/x-www-form-urlencoded}
69 * content string.
70 *
71 * @param params The from parameters.
72 * @param charset The encoding to use.
73 * @return content string
74 */
75 public static String format(final Iterable<? extends NameValuePair> params, final Charset charset) {
76 final StringBuilder buf = new StringBuilder();
77 URIBuilder.formatQuery(buf, params, charset, true);
78 return buf.toString();
79 }
80
81 }