com.fitbur.assertj.error.DescriptionFormatter Maven / Gradle / Ivy
The newest version!
/**
* 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.
*
* Copyright 2012-2016 the original author or authors.
*/
package com.fitbur.assertj.error;
import static com.fitbur.assertj.util.Strings.isNullOrEmpty;
import com.fitbur.assertj.description.Description;
import com.fitbur.assertj.util.VisibleForTesting;
/**
* Formats the {@link Description}s to be included in assertion errors.
*
* @author Alex Ruiz
*/
public class DescriptionFormatter {
private static final DescriptionFormatter INSTANCE = new DescriptionFormatter();
/**
* Returns the singleton instance of this class.
* @return the singleton instance of this class.
*/
public static DescriptionFormatter instance() {
return INSTANCE;
}
@VisibleForTesting
DescriptionFormatter() {}
/**
* Formats the given {@link Description} by surrounding its text value with square brackets and adding a space at
* the end.
* @param d the description to format. It can be {@code null}.
* @return the formatted description, or an empty {@code String} if the the {@code Description} is {@code null}.
*/
public String format(Description d) {
String s = (d != null) ? d.value() : null;
if (isNullOrEmpty(s)) return "";
return String.format("[%s] ", s);
}
}