001/*
002 *  Copyright 2018 Anyware Services
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 */
016package org.ametys.runtime.model;
017
018import java.util.Collections;
019import java.util.Map;
020
021import org.ametys.runtime.i18n.I18nizableText;
022
023/**
024 * Enumerator for listing values.<p>
025 * Such values usually depends on environment (directory listing, DB table, ...).
026 * @param <T> Type of the values
027 */
028public interface Enumerator<T>
029{
030    /**
031     * Retrieves a single label from a value.
032     * @param value the value.
033     * @return the label or <code>null</code> if not found.
034     * @throws Exception if an error occurs.
035     */
036    public I18nizableText getEntry(T value) throws Exception;
037    
038    /**
039     * Provides the enumerated values with their optional label.
040     * @return the enumerated values and their label.
041     * @throws Exception if an error occurs.
042     * TODO NEWATTRIBUTEAPI: rename this method when {@link org.ametys.runtime.parameter.Enumerator} will be removed
043     */
044    public Map<T, I18nizableText> getTypedEntries() throws Exception;
045    
046    /**
047     * Get the configuration of this enumerator
048     * @return the configuration
049     */
050    public default Map<String, Object> getConfiguration()
051    {
052        return Collections.EMPTY_MAP;
053    }
054    
055}