1 /*
   2  * Copyright (c) 2014, 2017, 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  * <pre>{@code
  44  *     Set<String> keys = MAC_CATEGORY.getDisplayableKeys();
  45  *
  46  *     String key = getLastValue(keys); // get last value for example
  47  *
  48  *     String value = MAC_CATEGORY.getValueForDisplayableKey(key);
  49  *     params.put(MAC_CATEGORY.getID(), value);
  50  * }</pre>
  51  *
  52  * @deprecated use {@link ToolProvider} to locate the {@code "javapackager"} tool instead.
  53  */
  54 @Deprecated(since="10", forRemoval=true)
  55 public class EnumeratedBundlerParam<T> extends BundlerParamInfo<T> {
  56     //Not sure if this is the correct order, my idea is that from and IDE's perspective
  57     //the string to display to the user is the key and then the value is some type of
  58     //object (although probably a String in most cases)
  59     private Map<String, T> elements;
  60     private boolean strict;
  61 
  62     public EnumeratedBundlerParam(String name,
  63                                   String description,
  64                                   String id,
  65                                   Class<T> valueType,
  66                                   Function<Map<String, ? super Object>, T> defaultValueFunction,
  67                                   BiFunction<String, Map<String, ? super Object>, T> stringConverter,
  68                                   Map<String, T> elements,
  69                                   boolean strict) {
  70         this.name = name;
  71         this.description = description;
  72         this.id = id;
  73         this.valueType = valueType;
  74         this.defaultValueFunction = defaultValueFunction;
  75         this.stringConverter = stringConverter;
  76         this.elements = elements;
  77         this.strict = strict;
  78     }
  79 
  80     public boolean isInPossibleValues(T value) {
  81         return elements.values().contains(value);
  82     }
  83 
  84     //Having the displayable values as the keys seems a bit wacky
  85     public Set<String> getDisplayableKeys() {
  86         return Collections.unmodifiableSet(elements.keySet());
  87     }
  88 
  89     // mapping from a "displayable" key to an "identifier" value.
  90     public T getValueForDisplayableKey(String displayableKey) {
  91         return elements.get(displayableKey);
  92     }
  93 
  94     public boolean isStrict() {
  95         return strict;
  96     }
  97 
  98     public boolean isLoose() {
  99         return !isStrict();
 100     }
 101 
 102     public T validatedFetchFrom(Map<String, ? super Object> params)
 103             throws InvalidBundlerParamException {
 104         if (isStrict()) {
 105             T value = fetchFrom(params);
 106             if (!isInPossibleValues(value)) {
 107                 throw new InvalidBundlerParamException("Parameter " + value.toString() + " not in valid set of values for BundlerParam " + name);
 108             }
 109             return value;
 110         }
 111         return fetchFrom(params);
 112     }
 113 
 114 }