/*
* ====================================================================
* 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.http.util;
import java.io.UnsupportedEncodingException;
import org.apache.http.Consts;
The home for utility methods that handle various encoding tasks.
Since: 4.0
/**
* The home for utility methods that handle various encoding tasks.
*
*
* @since 4.0
*/
public final class EncodingUtils {
Converts the byte array of HTTP content characters to a string. If
the specified charset is not supported, default system encoding
is used.
Params: - data – the byte array to be encoded
- offset – the index of the first byte to encode
- length – the number of bytes to encode
- charset – the desired character encoding
Returns: The result of the conversion.
/**
* Converts the byte array of HTTP content characters to a string. If
* the specified charset is not supported, default system encoding
* is used.
*
* @param data the byte array to be encoded
* @param offset the index of the first byte to encode
* @param length the number of bytes to encode
* @param charset the desired character encoding
* @return The result of the conversion.
*/
public static String getString(
final byte[] data,
final int offset,
final int length,
final String charset) {
Args.notNull(data, "Input");
Args.notEmpty(charset, "Charset");
try {
return new String(data, offset, length, charset);
} catch (final UnsupportedEncodingException e) {
return new String(data, offset, length);
}
}
Converts the byte array of HTTP content characters to a string. If
the specified charset is not supported, default system encoding
is used.
Params: - data – the byte array to be encoded
- charset – the desired character encoding
Returns: The result of the conversion.
/**
* Converts the byte array of HTTP content characters to a string. If
* the specified charset is not supported, default system encoding
* is used.
*
* @param data the byte array to be encoded
* @param charset the desired character encoding
* @return The result of the conversion.
*/
public static String getString(final byte[] data, final String charset) {
Args.notNull(data, "Input");
return getString(data, 0, data.length, charset);
}
Converts the specified string to a byte array. If the charset is not supported the
default system charset is used.
Params: - data – the string to be encoded
- charset – the desired character encoding
Returns: The resulting byte array.
/**
* Converts the specified string to a byte array. If the charset is not supported the
* default system charset is used.
*
* @param data the string to be encoded
* @param charset the desired character encoding
* @return The resulting byte array.
*/
public static byte[] getBytes(final String data, final String charset) {
Args.notNull(data, "Input");
Args.notEmpty(charset, "Charset");
try {
return data.getBytes(charset);
} catch (final UnsupportedEncodingException e) {
return data.getBytes();
}
}
Converts the specified string to byte array of ASCII characters.
Params: - data – the string to be encoded
Returns: The string as a byte array.
/**
* Converts the specified string to byte array of ASCII characters.
*
* @param data the string to be encoded
* @return The string as a byte array.
*/
public static byte[] getAsciiBytes(final String data) {
Args.notNull(data, "Input");
return data.getBytes(Consts.ASCII);
}
Converts the byte array of ASCII characters to a string. This method is
to be used when decoding content of HTTP elements (such as response
headers)
Params: - data – the byte array to be encoded
- offset – the index of the first byte to encode
- length – the number of bytes to encode
Returns: The string representation of the byte array
/**
* Converts the byte array of ASCII characters to a string. This method is
* to be used when decoding content of HTTP elements (such as response
* headers)
*
* @param data the byte array to be encoded
* @param offset the index of the first byte to encode
* @param length the number of bytes to encode
* @return The string representation of the byte array
*/
public static String getAsciiString(final byte[] data, final int offset, final int length) {
Args.notNull(data, "Input");
return new String(data, offset, length, Consts.ASCII);
}
Converts the byte array of ASCII characters to a string. This method is
to be used when decoding content of HTTP elements (such as response
headers)
Params: - data – the byte array to be encoded
Returns: The string representation of the byte array
/**
* Converts the byte array of ASCII characters to a string. This method is
* to be used when decoding content of HTTP elements (such as response
* headers)
*
* @param data the byte array to be encoded
* @return The string representation of the byte array
*/
public static String getAsciiString(final byte[] data) {
Args.notNull(data, "Input");
return getAsciiString(data, 0, data.length);
}
This class should not be instantiated.
/**
* This class should not be instantiated.
*/
private EncodingUtils() {
}
}