View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.creadur.whisker.app;
20  
21  /**
22   * Enumerates
23   */
24  public enum LicenseConfiguration {
25      /** Include source URLs in the LICENSE (as well as the NOTICE) */
26      INCLUDE_SOURCE_URLS,
27      /** The essentials only. */
28      MINIMAL;
29  
30      /**
31       * Default to include source URLs.
32       */
33      public static LicenseConfiguration DEFAULT_LICENSE_CONFIGURATION = INCLUDE_SOURCE_URLS;
34  
35      /**
36       * Replaces null with DEFAULT_LICENSE_CONFIGURATION.
37       * @param configuration possibly null
38       * @return not null
39       */
40      public static LicenseConfiguration notNull(final LicenseConfiguration configuration) {
41          final LicenseConfiguration result;
42          if (configuration == null) {
43              result = DEFAULT_LICENSE_CONFIGURATION;
44          } else {
45              result = configuration;
46          }
47          return result;
48      }
49  
50      /**
51       * Should source URLs be included in the LICENSE?
52       * @return true when source URLs should be included,
53       * false otherwise
54       */
55      public boolean includeSourceUrlsInLicense() {
56          return this == INCLUDE_SOURCE_URLS;
57      }
58  }