Java UTF8 Encode utf8Encode(final Collection col)

Description

Encodes the given collection of strings using HttpUtil#ENCODING encoding.

License

Apache License

Parameter

Parameter	Description
col	a collection of String s

Return

the encoded string

Declaration

public static String utf8Encode(final Collection<String> col) 

Method Source Code

//package com.java2s;
/*/*w  w w.j  a v a  2 s .  c  o m*/
 *  Copyright 2015 Telenav, Inc.
 *
 *  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.
 */

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.Collection;
import java.util.Map;

public class Main {
    public static final String ENCODING = "utf-8";

    /**
     * Encodes the given collection of strings using {@code HttpUtil#ENCODING} encoding.
     *
     * @param col a collection of {@code String}s
     * @return the encoded string
     */
    public static String utf8Encode(final Collection<String> col) {
        final StringBuilder param = new StringBuilder();
        for (final String elem : col) {
            param.append(elem).append(",");
        }
        return utf8Encode(param.substring(0, param.length() - 1));
    }

    /**
     * Encodes the given parameter using {@code HttpUtil#ENCODING} encoding.
     *
     * @param param the parameter to be encoded
     * @return the encoded parameter
     */
    public static String utf8Encode(final String param) {
        String encodedParam = null;
        try {
            encodedParam = URLEncoder.encode(param, ENCODING);
        } catch (final UnsupportedEncodingException ex) {
            /* should not appear since UTF-8 is a supported encoding */
        }
        return encodedParam;
    }

    /**
     * Encodes the given map of (parameter-value) pairs, using {@code HttpUtil#ENCODING} encoding. This method returns a
     * string of the following format: 'param1=val1&...paramN=valN'.
     *
     * @param params a map of ({@code String},{@code String}) pairs representing the input parameters of a method.
     * @return a {@code String} containing the list of encoded (parameter,value) pairs
     * @throws HttpException if the encoding failed
     */
    static String utf8Encode(final Map<String, String> params) {
        final StringBuilder result = new StringBuilder();
        for (final Map.Entry<String, String> param : params.entrySet()) {
            try {
                result.append(URLEncoder.encode(param.getKey(), ENCODING));
                result.append("=");
                result.append(URLEncoder.encode(param.getValue(), ENCODING));
                result.append("&");
            } catch (final UnsupportedEncodingException ex) {
                /* should not appear since UTF-8 is a supported encoding */
            }
        }
        if (result.length() > 0) {
            result.deleteCharAt(result.length() - 1);
        }
        return result.toString();
    }
}

Related

1. toUTF8Bytes(String string)
2. toUTF8InputStream(String str)
3. toUTF8String(byte[] b, int offset, int length)
4. utf8Code(String str)
5. Utf8codeCheck(String text)
6. utf8Encode(final String s)
7. utf8Encode(final String value)
8. utf8Encode(String s)
9. utf8Encode(String str)