org.cp.elements.text.FormatUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * 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.
 */

package org.cp.elements.text;

import java.text.MessageFormat;

/**
 * The {@link FormatUtils} class is an abstract utility class for working with text formatting.
 *
 * @author John J. Blum
 * @see java.lang.String
 * @see java.text.MessageFormat
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public abstract class FormatUtils {

  /**
   * Formats the given {@link String} of text.
   *
   * @param textPattern {@link String} text pattern to format.
   * @param args array of {@link Object} arguments to apply to the text pattern.
   * @return a formatted {@link String} of text with the arguments applied to the text pattern.
   * @see #messageFormat(String, Object...)
   * @see #stringFormat(String, Object...)
   * @see java.lang.String
   */
  public static String format(String textPattern, Object... args) {
    return messageFormat(stringFormat(textPattern, args), args);
  }

  /**
   * Formats the given {@link String} of text using the {@link MessageFormat} class.
   *
   * @param textPattern {@link String} text pattern to format.
   * @param args array of {@link Object} arguments to apply to the text pattern.
   * @return a formatted {@link String} of text with the arguments applied to the text pattern
   * using the {@link MessageFormat} class.
   * @see java.text.MessageFormat
   * @see java.lang.String
   */
  protected static String messageFormat(String textPattern, Object... args) {
    return MessageFormat.format(textPattern, args);
  }

  /**
   * Formats the given {@link String} of text using the {@link String#format(String, Object...)} method.
   *
   * @param textPattern {@link String} text pattern to format.
   * @param args array of {@link Object} arguments to apply to the text pattern.
   * @return a formatted {@link String} of text with the arguments applied to the text pattern
   * using the {@link String#format(String, Object...)} method.
   * @see java.lang.String#format(String, Object...)
   * @see java.lang.String
   */
  protected static String stringFormat(String textPattern, Object... args) {
    return String.format(textPattern, args);
  }
}