dev.utils.common.FormatUtils Maven / Gradle / Ivy

Go to download
package dev.utils.common;

import dev.utils.common.format.ArgsFormatter;
import dev.utils.common.format.UnitSpanFormatter;

/**
 * detail: 格式化工具类
 * @author Ttt
 */
public final class FormatUtils {

    private FormatUtils() {
    }

    // 日志 TAG
    private static final String TAG = FormatUtils.class.getSimpleName();

    /**
     * 字符串格式化
     * @param format 待格式化字符串
     * @param args   格式化参数
     * @return 格式化后的字符串
     */
    public static String format(
            final String format,
            final Object... args
    ) {
        return StringUtils.format(format, args);
    }

    // =============
    // = Unit Span =
    // =============

    /**
     * 获取 UnitSpanFormatter
     * @param precision 单位格式化精度
     * @return {@link UnitSpanFormatter}
     */
    public static UnitSpanFormatter unitSpanOf(
            final int precision
    ) {
        return UnitSpanFormatter.get(precision);
    }

    /**
     * 获取 UnitSpanFormatter
     * @param precision    单位格式化精度
     * @param defaultValue 格式化异常默认值
     * @return {@link UnitSpanFormatter}
     */
    public static UnitSpanFormatter unitSpanOf(
            final int precision,
            final String defaultValue
    ) {
        return UnitSpanFormatter.get(precision, defaultValue);
    }

    /**
     * 获取 UnitSpanFormatter
     * @param precision  单位格式化精度
     * @param appendZero 是否自动补 0 ( 只有 int、long 有效 )
     * @return {@link UnitSpanFormatter}
     */
    public static UnitSpanFormatter unitSpanOf(
            final int precision,
            final boolean appendZero
    ) {
        return UnitSpanFormatter.get(precision, appendZero);
    }

    /**
     * 获取 UnitSpanFormatter
     * @param precision    单位格式化精度
     * @param appendZero   是否自动补 0 ( 只有 int、long 有效 )
     * @param defaultValue 格式化异常默认值
     * @return {@link UnitSpanFormatter}
     */
    public static UnitSpanFormatter unitSpanOf(
            final int precision,
            final boolean appendZero,
            final String defaultValue
    ) {
        return UnitSpanFormatter.get(precision, appendZero, defaultValue);
    }

    // ========
    // = args =
    // ========

    /**
     * 获取 ArgsFormatter
     * @param startSpecifier  开始占位说明符
     * @param middleSpecifier 中间占位说明符
     * @return {@link ArgsFormatter}
     */
    public static ArgsFormatter argsOf(
            final String startSpecifier,
            final String middleSpecifier
    ) {
        return ArgsFormatter.get(startSpecifier, middleSpecifier);
    }

    /**
     * 获取 ArgsFormatter
     * @param startSpecifier  开始占位说明符
     * @param middleSpecifier 中间占位说明符
     * @param endSpecifier    结尾占位说明符
     * @return {@link ArgsFormatter}
     */
    public static ArgsFormatter argsOf(
            final String startSpecifier,
            final String middleSpecifier,
            final String endSpecifier
    ) {
        return ArgsFormatter.get(
                startSpecifier, middleSpecifier, endSpecifier
        );
    }

    /**
     * 获取 ArgsFormatter
     * @param startSpecifier  开始占位说明符
     * @param middleSpecifier 中间占位说明符
     * @param endSpecifier    结尾占位说明符
     * @param throwError      是否抛出异常
     * @param defaultValue    格式化异常默认值
     * @return {@link ArgsFormatter}
     */
    public static ArgsFormatter argsOf(
            final String startSpecifier,
            final String middleSpecifier,
            final String endSpecifier,
            final boolean throwError,
            final String defaultValue
    ) {
        return ArgsFormatter.get(
                startSpecifier, middleSpecifier, endSpecifier,
                throwError, defaultValue
        );
    }
}