Java Message Format format(String textPattern, Object... args)

Description

Formats the given String of text.

License

Apache License

Parameter

Parameter	Description
textPattern	String text pattern to format.
args	array of Object arguments to apply to the text pattern.

Return

a formatted of text with the arguments applied to the text pattern.

Declaration

public static String format(String textPattern, Object... args) 

Method Source Code

//package com.java2s;
/*/*www .j  av a 2 s .c  o m*/
 * 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.
 */

import java.text.MessageFormat;

public class Main {
    /**
     * 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);
    }
}

Related

1. format(String pattern, Map params)
2. format(String pattern, Object... args)
3. format(String pattern, String[] replacements)
4. format(String str, int replacement)
5. format(String str, Object... arguments)
6. formatAsNumber(double value)
7. formatCause(final String message, final Throwable cause, final Object... args)
8. formatDuring(long mss, String pattern)
9. formatError(Map.Entry entry, String errorPlural, String errorSingular)