1 /* 2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.oracle.tools.packager; 27 28 import java.util.*; 29 import java.util.function.BiFunction; 30 import java.util.function.Function; 31 32 /** 33 * 34 * The class contains key-value pairs (elements) where keys are "displayable" keys 35 * which the IDE can display/choose and values are "identifier" values which can be stored 36 * in parameters' map. 37 * 38 * For instance the Mac has a predefined set of categories which can be applied 39 * to LSApplicationCategoryType which is required for the mac app store. 40 * 41 * The following example illustrates a simple usage of the MAC_CATEGORY parameter 42 * 43 * Set<String> keys = MAC_CATEGORY.getDisplayableKeys(); 44 * 45 * String key = getLastValue(keys); // get last value for example 46 * 47 * String value = MAC_CATEGORY.getValueForDisplayableKey(key); 48 * params.put(MAC_CATEGORY.getID(), value); 49 * 50 */ 51 public class EnumeratedBundlerParam<T> extends BundlerParamInfo<T> { 52 //Not sure if this is the correct order, my idea is that from and IDE's perspective 53 //the string to display to the user is the key and then the value is some type of 54 //object (although probably a String in most cases) 55 private Map<String, T> elements; 56 private boolean strict; 57 58 public EnumeratedBundlerParam(String name, 59 String description, 60 String id, 61 Class<T> valueType, 62 Function<Map<String, ? super Object>, T> defaultValueFunction, 63 BiFunction<String, Map<String, ? super Object>, T> stringConverter, 64 Map<String, T> elements, 65 boolean strict) { 66 this.name = name; 67 this.description = description; 68 this.id = id; 69 this.valueType = valueType; 70 this.defaultValueFunction = defaultValueFunction; 71 this.stringConverter = stringConverter; 72 this.elements = elements; 73 this.strict = strict; 74 } 75 76 public boolean isInPossibleValues(T value) { 77 return elements.values().contains(value); 78 } 79 80 //Having the displayable values as the keys seems a bit wacky 81 public Set<String> getDisplayableKeys() { 82 return Collections.unmodifiableSet(elements.keySet()); 83 } 84 85 // mapping from a "displayable" key to an "identifier" value. 86 public T getValueForDisplayableKey(String displayableKey) { 87 return elements.get(displayableKey); 88 } 89 90 public boolean isStrict() { 91 return strict; 92 } 93 94 public boolean isLoose() { 95 return !isStrict(); 96 } 97 98 public T validatedFetchFrom(Map<String, ? super Object> params) 99 throws InvalidBundlerParamException { 100 if (isStrict()) { 101 T value = fetchFrom(params); 102 if (!isInPossibleValues(value)) { 103 throw new InvalidBundlerParamException("Parameter " + value.toString() + " not in valid set of values for BundlerParam " + name); 104 } 105 return value; 106 } 107 return fetchFrom(params); 108 } 109 110 }