URLEncodedString.java

/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.search.elasticsearch.client.impl;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Objects;

import org.hibernate.search.exception.AssertionFailure;

import com.google.gson.JsonElement;

/**
 * To avoid re-encoding strings into URLs we have several opportunities
 * to reuse them and compose them more efficiently.
 */
public final class URLEncodedString {

	public final String encoded;
	public final String original;

	/**
	 * Do not invoke directly.
	 * @see #fromString(String)
	 * @see #fromJSon(JsonElement)
	 * @param string the original string to be encoded.
	 */
	private URLEncodedString(String string) {
		this.original = string;
		try {
			encoded = URLEncoder.encode( string, StandardCharsets.UTF_8.name() );
		}
		catch (UnsupportedEncodingException e) {
			throw new AssertionFailure( "Unexpected error retrieving the UTF-8 charset", e );
		}
	}

	@Override
	public String toString() {
		return original;
	}

	@Override
	public int hashCode() {
		return original.hashCode();
	}

	@Override
	public boolean equals(Object obj) {
		if ( this == obj ) {
			return true;
		}
		else if ( obj == null ) {
			return false;
		}
		else if ( URLEncodedString.class != obj.getClass() ) {
			return false;
		}
		else {
			URLEncodedString other = (URLEncodedString) obj;
			return original.equals( other.original );
		}
	}

	public static URLEncodedString fromString(String string) {
		Objects.requireNonNull( string );
		return new URLEncodedString( string );
	}

	public static URLEncodedString fromJSon(JsonElement jsonElement) {
		Objects.requireNonNull( jsonElement );
		return fromString( jsonElement.getAsString() );
	}

}