001package ball.util;
002/*-
003 * ##########################################################################
004 * Utilities
005 * $Id: EnumLookupMap.java 5285 2020-02-05 04:23:21Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-util/trunk/src/main/java/ball/util/EnumLookupMap.java $
007 * %%
008 * Copyright (C) 2008 - 2020 Allen D. Ball
009 * %%
010 * Licensed under the Apache License, Version 2.0 (the "License");
011 * you may not use this file except in compliance with the License.
012 * You may obtain a copy of the License at
013 *
014 *      http://www.apache.org/licenses/LICENSE-2.0
015 *
016 * Unless required by applicable law or agreed to in writing, software
017 * distributed under the License is distributed on an "AS IS" BASIS,
018 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
019 * See the License for the specific language governing permissions and
020 * limitations under the License.
021 * ##########################################################################
022 */
023import java.util.TreeMap;
024import java.util.stream.Stream;
025
026/**
027 * {@link java.util.SortedMap} implementation which provides
028 * {@link String#CASE_INSENSITIVE_ORDER} look-up by name to the
029 * corresponding {@link Enum}.
030 *
031 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
032 * @version $Revision: 5285 $
033 */
034public class EnumLookupMap extends TreeMap<String,Enum<?>> {
035    private static final long serialVersionUID = -3569976523862652175L;
036
037    /**
038     * Sole constructor.
039     *
040     * @param   types           The {@link Enum} types to include.
041     */
042    @SafeVarargs @SuppressWarnings({ "varargs" })
043    public EnumLookupMap(Class<? extends Enum<?>>... types) {
044        super(String.CASE_INSENSITIVE_ORDER);
045
046        Stream.of(types)
047            .flatMap(t -> Stream.of(t.getEnumConstants()))
048            .forEach(t -> put(t.name(), t));
049    }
050}