View Javadoc
1   package org.apache.rat.config;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * Value of addLicenseHeaders configuration option.
24   */
25  public enum AddLicenseHeaders {
26      TRUE, //
27      FALSE, //
28      FORCED;
29  
30      private static final char SEPARATOR = '|';
31  
32      /**
33       * @return pretty-printed list of all available options.
34       */
35      public static String getValuesForHelp() {
36          StringBuilder sb = new StringBuilder();
37          for(AddLicenseHeaders headerOption : AddLicenseHeaders.values()) {
38              sb.append(headerOption.name().toLowerCase()).append(SEPARATOR);
39          }
40          // remove last separator
41          sb.setLength(sb.length() - 1);
42          return sb.toString();
43      }
44  }