001/*
002 *  Copyright 2012 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.parameter;
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 */
027public interface Enumerator
028{
029    /**
030     * Retrieves a single label from a value.
031     * @param value the value.
032     * @return the label or <code>null</code> if not found.
033     * @throws Exception if an error occurs.
034     */
035    public I18nizableText getEntry(String value) throws Exception;
036    
037    /**
038     * Provides the enumerated values with their optional label.
039     * @return the enumerated values and their label.
040     * @throws Exception if an error occurs.
041     */
042    public Map<Object, I18nizableText> getEntries() throws Exception;
043    
044    /**
045     * Get the configuration this enumerator
046     * @return the configuration
047     */
048    public default Map<String, Object> getConfiguration()
049    {
050        return Collections.EMPTY_MAP;
051    }
052}