001/*
002 * Copyright 2017-2022 Product Mog LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.lokalized;
018
019import org.jspecify.annotations.NonNull;
020
021import java.util.Arrays;
022import java.util.Collections;
023import java.util.Map;
024import java.util.stream.Collectors;
025
026/**
027 * Language clusivity forms.
028 *
029 * @author <a href="https://revetkn.com">Mark Allen</a>
030 * @since 1.2.0
031 */
032public enum Clusivity implements LanguageForm {
033        /**
034         * Inclusive "we/us" (includes the addressee).
035         */
036        INCLUSIVE,
037        /**
038         * Exclusive "we/us" (excludes the addressee).
039         */
040        EXCLUSIVE;
041
042        @NonNull
043        private static final Map<@NonNull String, @NonNull Clusivity> CLUSIVITIES_BY_NAME;
044
045        static {
046                CLUSIVITIES_BY_NAME = Collections.unmodifiableMap(Arrays.stream(
047                                Clusivity.values()).collect(Collectors.toMap(clusivity -> clusivity.name(), clusivity -> clusivity)));
048        }
049
050        /**
051         * Gets the mapping of clusivity names to clusivity values.
052         *
053         * @return the mapping of clusivity names to clusivity values, not null
054         */
055        @NonNull
056        static Map<@NonNull String, @NonNull Clusivity> getClusivitiesByName() {
057                return CLUSIVITIES_BY_NAME;
058        }
059}