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   * Immutable context for operations.
23   */
24  public class Configuration {
25  
26      /**
27       * Should source URLs be included in the license text?
28       */
29      private final boolean includeSourceUrlsInLicense;
30  
31      /**
32       * Constructs an immutable context for operations.
33       * @param includeSourceUrlsInLicense true when source URLs should
34       * be included in the license text, false otherwise
35       */
36      public Configuration(final boolean includeSourceUrlsInLicense) {
37          this.includeSourceUrlsInLicense = includeSourceUrlsInLicense;
38      }
39  
40      /**
41       * Should source URLs be included in the license text?
42       * @return true when source URLs should be included in the license text
43       */
44      public boolean includeSourceURLsInLicense() {
45          return includeSourceUrlsInLicense;
46      }
47  
48      /**
49       * Suitable for logging.
50       * return not null
51       */
52      @Override
53      public String toString() {
54          return "Configuration [includeSourceUrlsInLicense="
55                  + includeSourceUrlsInLicense + "]";
56      }
57  }