com.force.i18n.LocaleInfoBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grammaticus Show documentation

Localization Framework that allows grammatically correct renaming of nouns

There is a newer version: 1.2.30

/* 
 * Copyright (c) 2017, salesforce.com, inc.
 * All rights reserved.
 * Licensed under the BSD 3-Clause license. 
 * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
 */

package com.force.i18n;

import java.util.Locale;

/**
 * Builder of LocaleInfo instances.
 * @author jared.pearson
 */
class LocaleInfoBuilder {
    private final Locale locale;
    private boolean useEasternNameOrder = false;
    private boolean formal = false;
    
    /**
     * Creates a new {@link LocaleInfo} instance for the given Locale. The properties are set as follows:
     * 
     * useEasterNameOrder: false
     * 
formal: false
     * 
     * @param locale the Locale associated to the {@link LocaleInfo} being built
     */
    public LocaleInfoBuilder(Locale locale) {
        assert locale != null : "locale should not be null";
        this.locale = locale;
    }

    /**
     * Changes the {@link LocaleInfo#useEasternNameOrder()} value to true
     * @return this
     */
    public LocaleInfoBuilder useEasternNameOrder() {
        return this.useEasternNameOrder(true);
    }
    
    /**
     * Changes the {@link LocaleInfo#useEasternNameOrder()} value
     * @return this
     */
    public LocaleInfoBuilder useEasternNameOrder(boolean useEasternNameOrder) {
        this.useEasternNameOrder = useEasternNameOrder;
        return this;
    }
    
    /**
     * Changes the {@link LocaleInfo#isFormal()} value to true
     * @return this
     */
    public LocaleInfoBuilder formal() {
        return this.formal(true);
    }

    /**
     * Changes the {@link LocaleInfo#isFormal()} value
     * @return this
     */
    public LocaleInfoBuilder formal(boolean formal) {
        this.formal = formal;
        return this;
    }
    
    /**
     * Builds a new {@link LocaleInfo} instance
     */
    public LocaleInfo build() {
        return new LocaleInfoImpl(locale, useEasternNameOrder, formal);
    }
}