apache-whisker-app/src/main/java/org/apache/creadur/whisker/app/Configuration.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.creadur.whisker.app;

/**
 * Immutable context for operations.
 */
public class Configuration {

    /**
     * Should source URLs be included in the license text?
     */
    private final boolean includeSourceUrlsInLicense;

    /**
     * Constructs an immutable context for operations.
     * @param includeSourceUrlsInLicense true when source URLs should
     * be included in the license text, false otherwise
     */
    public Configuration(final boolean includeSourceUrlsInLicense) {
        this.includeSourceUrlsInLicense = includeSourceUrlsInLicense;
    }

    /**
     * Should source URLs be included in the license text?
     * @return true when source URLs should be included in the license text
     */
    public boolean includeSourceURLsInLicense() {
        return includeSourceUrlsInLicense;
    }

    /**
     * Suitable for logging.
     * return not null
     */
    @Override
    public String toString() {
        return "Configuration [includeSourceUrlsInLicense="
                + includeSourceUrlsInLicense + "]";
    }
}