org.databene.commons.converter.URLEncodeConverter Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2004-2014 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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.
 */
package org.databene.commons.converter;

import java.net.URLEncoder;

import org.databene.commons.ConversionException;
import org.databene.commons.Encodings;

/**
 * Converts Strings to their URL-encoded representation.

 * 

 * Created at 04.07.2009 07:11:19
 * @since 0.5.0
 * @author Volker Bergmann
 */

public class URLEncodeConverter extends ThreadSafeConverter {
	
	private String encoding;
	
    public URLEncodeConverter() {
	    this(Encodings.UTF_8);
    }

    public URLEncodeConverter(String encoding) {
	    super(String.class, String.class);
    }

    @Override
	public String convert(String sourceValue) throws ConversionException {
        return convert(sourceValue, encoding);
    }

	public static String convertUTF8(String sourceValue) throws ConversionException {
        return convert(sourceValue, Encodings.UTF_8);
    }
	
	public static String convert(String sourceValue, String encoding) throws ConversionException {
	    try {
	        return URLEncoder.encode(sourceValue, encoding);
        } catch (Exception e) {
        	throw new ConversionException("URLEncoding of '" + sourceValue 
        			+ "' failed for encoding '" + encoding + "'", e);
        }
    }
	
}