I18NKey.java

/*
 *
 *  * Copyright (c) 2016. David Sowerby
 *  *
 *  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 *  * the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 *  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 *  * specific language governing permissions and limitations under the License.
 *
 */
package uk.q3c.krail.core.i18n;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

public interface I18NKey {
    /**
     * returns a full string representation of an I18NKey enum constant (for example  uk.q3c.krail.core.i18n.LabelKey.Yes)
     * @param key
     * @return
     */
    @SuppressFBWarnings("PDP_POORLY_DEFINED_PARAMETER")
    static String fullName(I18NKey key) {
        Enum e = (Enum) key;
        return e.getClass()
                .getName() + '.' + e.name();
    }

    static <E extends Enum<E> & I18NKey> Class<? extends Enum> enumClass(E k) {
        return k.getClass();
    }

    /**
     * Provides a default bundle name by removing the last 3 characters from the key name and replacing with an 's'.
     * This conforms to the Krail convention of having, for example, LabelKey, referring to Labels.
     * <p>
     * This can of course be overridden by implementing classes.
     *
     * @return
     */
    default String bundleName() {
        return this.getClass()
                                          .getSimpleName()
                   .substring(0, getClass().getSimpleName()
                                           .length() - 3) + 's';
    }

}