org.solovyev.common.text.Formatter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 serso aka se.solovyev
 *
 * 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.
 *
 * ---------------------------------------------------------------------
 * Contact details
 *
 * Email: [email protected]
 * Site:  http://se.solovyev.org
 */

package org.solovyev.common.text;

import javax.annotation.Nullable;

/**
 * User: serso
 * Date: 9/20/11
 * Time: 10:35 PM
 */
public interface Formatter {
	/**
	 * Method formats string value of specified object
	 *
	 * @param value object to be converted to string
	 * @return string representation of current object
	 * @throws IllegalArgumentException illegal argument exception in case of any error (AND ONLY ONE EXCEPTION, I.E. NO NUMBER FORMAT EXCEPTIONS AND SO ON)
	 */
	@Nullable
	String formatValue(@Nullable T value) throws IllegalArgumentException;
}