de.carne.gradle.plugin.java.util.Strings Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016-2020 Holger de Carne and contributors, All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package de.carne.gradle.plugin.java.util;

import org.eclipse.jdt.annotation.Nullable;

/**
 * Utility class providing {@linkplain String} related functions.
 */
public final class Strings {

	private Strings() {
		// Prevent instantiation
	}

	/**
	 * Checks whether a {@linkplain String} is empty.
	 * 
	 * A {@linkplain String} is considered empty if it is either {@code null} or of length {@code 0}.
	 *
	 * @param s the {@linkplain String} to check.
	 * @return {@code true} if the string is empty.
	 */
	public static boolean isEmpty(@Nullable String s) {
		return s == null || s.length() == 0;
	}

	/**
	 * Checks whether a {@linkplain String} is not empty.
	 * 
	 * A {@linkplain String} is considered empty if it is either {@code null} or of length {@code 0}.
	 *
	 * @param s the {@linkplain String} to check.
	 * @return {@code true} if the string is not empty.
	 */
	public static boolean notEmpty(@Nullable String s) {
		return s != null && s.length() > 0;
	}

	/**
	 * Makes sure a {@linkplain String} is not {@code null}.
	 *
	 * @param s the {@linkplain String} to check.
	 * @return the submitted {@linkplain String} or {@code ""} if {@code null} was submitted.
	 */
	public static String safe(@Nullable String s) {
		return (s != null ? s : "");
	}

}