View Javadoc
1   /*
2    * This file is part of ***  M y C o R e  ***
3    * See http://www.mycore.de/ for details.
4    *
5    * MyCoRe is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * MyCoRe is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License
16   * along with MyCoRe.  If not, see <http://www.gnu.org/licenses/>.
17   */
18  package org.mycore.user2;
19  
20  import java.util.Map;
21  
22  /**
23   * @author Ren\u00E9 Adler (eagle)
24   *
25   */
26  public interface MCRUserAttributeConverter<ValueType, BoundType> {
27  
28      /**
29       * Convert a given value to the specified type.
30       * 
31       * @param value the value of type <code>&lt;ValueType&gt;</code>, to convert
32       * @param separator the value separator or <code>null</code>
33       * @param valueMapping the value mapping or <code>null</code>
34       * @return the converted value of type <code>&lt;BoundType&gt;</code>
35       * @throws Exception if there's an error during the conversion.
36       */
37      BoundType convert(ValueType value, String separator, Map<String, String> valueMapping)
38          throws Exception;
39  }