nl.vpro.i18n.MultiLanguageString Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vpro-shared-i18n Show documentation
There is a newer version: 5.3.1
package nl.vpro.i18n;

import lombok.Getter;
import lombok.Setter;

import java.text.MessageFormat;
import java.util.*;
import java.util.function.Supplier;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.meeuw.i18n.languages.LanguageCode;
import org.slf4j.helpers.FormattingTuple;
import org.slf4j.helpers.MessageFormatter;

import static java.util.Locale.ENGLISH;
import static nl.vpro.i18n.Locales.DUTCH;

/**
 * Represent multiple strings for different locales.
 * 
 * This is a simple way to internationalize a string, completely in code.
 * 

 * It supports three ways of providing parameters.
 * 

 *     slf4j style {@link Builder#slf4jArgs(Object...)}
 *     {@link MessageFormat} style with {@link Builder#args(Object...)}
 *     {@link String#formatted(Object...)} style with {@link Builder#formatted(Object...)}
 * 
 * @author Michiel Meeuwissen
 * @since 0.47
 */
public class MultiLanguageString implements CharSequence {

    private final Map strings = new HashMap<>();

    @Getter
    @Setter
    private Locale defaultLocale = null;


    private Object[] slf4jArgs;

    private Object[] args;

    private Object[] formatArgs;

    private String bundleName;

    private String key;


    public static Builder.In in(Locale locale) {
        Builder builder = new Builder();
        return builder.defaultLocale(locale).in(locale);
    }

    public static Builder.In in(LanguageCode language) {
        Builder builder = new Builder();
        Locale locale = language.toLocale();
        return builder.defaultLocale(locale).in(locale);
    }

    public static Builder of(Locale locale, String text) {
        return in(locale).is(text);
    }

    /**
     * Created a {@link Builder} for a {@link MultiLanguageString} and adds English text to it.
     */
    public static Builder en(String text) {
        Builder builder = new Builder();
        return builder.en(text);
    }
    public static Builder builder() {
        return new Builder();
    }

    public static String get(CharSequence charSequence, Locale locale) {
        if (charSequence instanceof MultiLanguageString multiLanguageString){
            return multiLanguageString.get(locale);
        } else {
            return charSequence.toString();
        }
    }

    public String get(Locale locale) {
        LocalizedString localized = getLocalized(locale);
        if (localized != null) {
            return localized.getValue();
        } else {
            return null;
        }
    }

    public LocalizedString getLocalized(Locale locale) {
        String result = strings.get(locale);
        while (result == null && Locales.simplifyable(locale)) {
            locale = Locales.simplify(locale);
            result = strings.get(locale);
        }
        if (result == null) {
            if (bundleName != null) {
                ResourceBundle bundle = ResourceBundle.getBundle(bundleName, locale);
                result = bundle.getString(key);
            } else {
                result = strings.get(defaultLocale);
            }
        }
        if (result != null) {
            if (args != null) {
                MessageFormat ft = new MessageFormat(result);
                ft.setLocale(locale);
                result = ft.format(args);
            }
            if (slf4jArgs != null) {
                FormattingTuple ft = MessageFormatter.arrayFormat(result, slf4jArgs);
                result = ft.getMessage();
            }

            if (formatArgs != null) {
                result = result.formatted(formatArgs);
            }
        }
        return LocalizedString.of(result, locale);

    }

    @Override
    public int length() {
        return toString().length();

    }

    @Override
    public char charAt(int index) {
        return toString().charAt(index);

    }

    @Override
    public @NonNull CharSequence subSequence(int start, int end) {
        return toString().subSequence(start, end);

    }

    @Override
    @NonNull
    public String toString() {
        String s = get(defaultLocale == null ? Locales.getDefault() : defaultLocale);
        if (s == null) {
            return "";
        }
        return s;
    }

    public static class Builder implements Supplier {
        MultiLanguageString created = new MultiLanguageString();

        public Builder defaultLocale(Locale locale) {
            created.defaultLocale = locale;
            return this;
        }

        public Builder defaultLocale(LanguageCode locale) {
            created.defaultLocale = locale.toLocale();
            return this;
        }

        public Builder slf4jArgs(Object... args) {
            created.slf4jArgs = args;
            return this;
        }

         public Builder args(Object... args) {
            created.args = args;
            return this;
        }

        public Builder formatted(Object... args) {
            created.formatArgs = args;
            return this;
        }

        /**
         * Adds Dutch text to the {@link MultiLanguageString} being built.
         */
        public Builder nl(String text) {
            created.strings.put(DUTCH, text);
            return this;
        }

        /**
         * Adds English text to the {@link MultiLanguageString} being built.
         */
        public Builder en(String text) {
            created.strings.put(ENGLISH, text);
            return this;
        }

        public Builder bundle(String bundleName, String key) {
            created.bundleName = bundleName;
            created.key = key;
            ResourceBundle.getBundle(bundleName);
            return this;
        }

        public In in(Locale locale) {
            return new In(locale);
        }

        public In in(String locale) {
            return in(LanguageCode.languageCode(locale));
        }

        public In in(LanguageCode language) {
            return in(language.toLocale());
        }

        public MultiLanguageString build() {
            return created;
        }

        @Override
        public CharSequence get() {
            return build();
        }

        public class In {
            private final Locale locale;

            public In(Locale locale) {
                this.locale = locale;
            }

            public Builder is(String string) {
                Builder.this.created.strings.put(locale, string);
                return Builder.this;
            }
        }
    }
}