com.rapiddweller.common.converter.URLEncodeConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation

'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.

There is a newer version: 2.0.1-jdk-11

Show newest version

/*
 * Copyright (C) 2004-2015 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 com.rapiddweller.common.converter;

import com.rapiddweller.common.ConversionException;
import com.rapiddweller.common.Encodings;

import java.net.URLEncoder;

/**
 * Converts Strings to their URL-encoded representation.
 * Created at 04.07.2009 07:11:19
 *
 * @author Volker Bergmann
 * @since 0.5.0
 */
public class URLEncodeConverter extends ThreadSafeConverter {

  private String encoding;

  /**
   * Instantiates a new Url encode converter.
   */
  public URLEncodeConverter() {
    this(Encodings.UTF_8);
  }

  /**
   * Instantiates a new Url encode converter.
   *
   * @param encoding the encoding
   */
  public URLEncodeConverter(String encoding) {
    super(String.class, String.class);
  }

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

  /**
   * Convert utf 8 string.
   *
   * @param sourceValue the source value
   * @return the string
   * @throws ConversionException the conversion exception
   */
  public static String convertUTF8(String sourceValue) throws ConversionException {
    return convert(sourceValue, Encodings.UTF_8);
  }

  /**
   * Convert string.
   *
   * @param sourceValue the source value
   * @param encoding    the encoding
   * @return the string
   * @throws ConversionException the conversion exception
   */
  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);
    }
  }

}