com.softicar.platform.common.core.i18n.DisplayStrings Maven / Gradle / Ivy

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

The SoftiCAR Platform is a lightweight, Java-based library to create interactive business web applications.

There is a newer version: 50.0.0

package com.softicar.platform.common.core.i18n;

import java.util.Optional;
import java.util.stream.Collector;

/**
 * Utility methods for {@link IDisplayString}.
 *
 * @author Oliver Richers
 */
public class DisplayStrings {

	/**
	 * Creates a new {@link DisplayStringJoiningCollector} with
	 * {@link IDisplayString#EMPTY} as separator.
	 *
	 * @return new instance of {@link DisplayStringJoiningCollector} (never
	 *         null)
	 */
	public static Collector joining() {

		return joining(IDisplayString.EMPTY);
	}

	/**
	 * Creates a new {@link DisplayStringJoiningCollector} with the given
	 * separator.
	 *
	 * @return new instance of {@link DisplayStringJoiningCollector} (never
	 *         null)
	 */
	public static Collector joining(IDisplayString separator) {

		return new DisplayStringJoiningCollector(separator);
	}

	/**
	 * Creates a new {@link IDisplayString} from the given plain {@link String}.
	 * 
	 * The given {@link String} will not be translated.
	 * 

	 * If the given {@link String} is null, {@link IDisplayString#EMPTY}
	 * will be returned.
	 *
	 * @param string
	 *            the plain {@link String} (may be null)
	 * @return the new {@link IDisplayString} (never null)
	 */
	static IDisplayString create(String string) {

		return Optional//
			.ofNullable(string)
			.map(PlainDisplayString::new)
			.orElse(new PlainDisplayString(""));
	}

	/**
	 * Creates a new {@link IDisplayString} from the given formatting
	 * {@link String} and formatting arguments.
	 * 

	 * The given {@link String} will not be translated.
	 * 

	 * If the given {@link String} is null, {@link IDisplayString#EMPTY}
	 * will be returned. In that case, formatting arguments are ignored.
	 *
	 * @param formatString
	 *            the formatting {@link String} (may be null)
	 * @param arguments
	 *            the formatting arguments (never null)
	 * @return the new {@link IDisplayString} (never null)
	 */
	static IDisplayString format(String formatString, Object...arguments) {

		return formatAsOptional(formatString, arguments).orElse(IDisplayString.EMPTY);
	}

	/**
	 * Creates a new {@link IDisplayString} from the given formatting
	 * {@link String} and formatting arguments.
	 * 

	 * The given {@link String} will not be translated.
	 * 
	 * If the given {@link String} is null, {@link Optional#empty()} will
	 * be returned. In that case, formatting arguments are ignored.
	 *
	 * @param formatString
	 *            the formatting {@link String} (may be null)
	 * @param arguments
	 *            the formatting arguments (never null)
	 * @return the new {@link IDisplayString}
	 */
	static Optional formatAsOptional(String formatString, Object...arguments) {

		return Optional.ofNullable(formatString).map(it -> {
			var string = arguments.length > 0? String.format(it, arguments) : it;
			return create(string);
		});
	}
}