1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/util/EncodingUtils.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 503413 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-02-04 06:22:14 -0800 (Sun, 04 Feb 2007) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.util; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.UnsupportedEncodingException; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.protocol.HTTP; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The home for utility methods that handle various encoding tasks. 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Michael Becke 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic final class EncodingUtils { 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Converts the byte array of HTTP content characters to a string. If 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the specified charset is not supported, default system encoding 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * is used. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param data the byte array to be encoded 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param offset the index of the first byte to encode 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param length the number of bytes to encode 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param charset the desired character encoding 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The result of the conversion. 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getString( 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project final byte[] data, 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int offset, 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project int length, 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String charset 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ) { 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (data == null) { 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Parameter may not be null"); 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (charset == null || charset.length() == 0) { 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("charset may not be null or empty"); 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new String(data, offset, length, charset); 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (UnsupportedEncodingException e) { 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new String(data, offset, length); 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Converts the byte array of HTTP content characters to a string. If 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the specified charset is not supported, default system encoding 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * is used. 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param data the byte array to be encoded 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param charset the desired character encoding 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The result of the conversion. 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getString(final byte[] data, final String charset) { 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (data == null) { 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Parameter may not be null"); 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return getString(data, 0, data.length, charset); 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Converts the specified string to a byte array. If the charset is not supported the 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * default system charset is used. 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param data the string to be encoded 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param charset the desired character encoding 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The resulting byte array. 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static byte[] getBytes(final String data, final String charset) { 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (data == null) { 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("data may not be null"); 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (charset == null || charset.length() == 0) { 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("charset may not be null or empty"); 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return data.getBytes(charset); 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (UnsupportedEncodingException e) { 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return data.getBytes(); 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Converts the specified string to byte array of ASCII characters. 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param data the string to be encoded 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The string as a byte array. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static byte[] getAsciiBytes(final String data) { 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (data == null) { 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Parameter may not be null"); 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return data.getBytes(HTTP.US_ASCII); 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (UnsupportedEncodingException e) { 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new Error("HttpClient requires ASCII support"); 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Converts the byte array of ASCII characters to a string. This method is 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to be used when decoding content of HTTP elements (such as response 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * headers) 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param data the byte array to be encoded 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param offset the index of the first byte to encode 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param length the number of bytes to encode 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The string representation of the byte array 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getAsciiString(final byte[] data, int offset, int length) { 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (data == null) { 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Parameter may not be null"); 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return new String(data, offset, length, HTTP.US_ASCII); 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (UnsupportedEncodingException e) { 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new Error("HttpClient requires ASCII support"); 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Converts the byte array of ASCII characters to a string. This method is 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to be used when decoding content of HTTP elements (such as response 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * headers) 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param data the byte array to be encoded 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The string representation of the byte array 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getAsciiString(final byte[] data) { 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (data == null) { 174069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Parameter may not be null"); 175069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 176069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return getAsciiString(data, 0, data.length); 177069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 178069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 179069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 180069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This class should not be instantiated. 181069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 182069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private EncodingUtils() { 183069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 184069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 185069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 186