All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

/*
 * 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.Nonnull;
import javax.annotation.Nullable;

/**
 * User: serso
 * Date: 9/20/11
 * Time: 10:52 PM
 */
public class ValueOfFormatter implements Formatter {

	/*
	**********************************************************************
	*
	*                           STATIC
	*
	**********************************************************************
	*/

	@Nonnull
	private static final ValueOfFormatter notNullFormatter = new ValueOfFormatter(false);

	@Nonnull
	private static final ValueOfFormatter nullableFormatter = new ValueOfFormatter(true);

	@Nonnull
	public static  ValueOfFormatter getNotNullFormatter() {
		return (ValueOfFormatter) notNullFormatter;
	}

	@Nonnull
	public static  ValueOfFormatter getNullableFormatter() {
		return (ValueOfFormatter) nullableFormatter;
	}

	/*
	**********************************************************************
	*
	*                           FIELDS
	*
	**********************************************************************
	*/

	private final boolean processNulls;

	/*
	**********************************************************************
	*
	*                           CONSTRUCTORS
	*
	**********************************************************************
	*/

	private ValueOfFormatter() {
		this(false);
	}

	private ValueOfFormatter(boolean processNulls) {
		this.processNulls = processNulls;
	}

	/*
	**********************************************************************
	*
	*                           METHODS
	*
	**********************************************************************
	*/

	@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = {"NP_LOAD_OF_KNOWN_NULL_VALUE"}, justification = "If 'processNulls' is true => must result 'null'")
	@Override
	public String formatValue(@Nullable T t) throws IllegalArgumentException {
		if (t == null) {
			if (processNulls) {
				return String.valueOf(t);
			} else {
				return null;
			}
		} else {
			return String.valueOf(t);
		}
	}
}