apache-whisker-app/src/main/java/org/apache/creadur/whisker/app/Result.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;

import java.io.File;

/**
 * Names results which might be produced by Whisker.
 */
public enum Result {
    /** Software license. */
    LICENSE("LICENSE"),
    /** Software notice. */
    NOTICE("NOTICE"),
    /** Describes missing meta-data. */
    MISSING_LICENSE_REPORT("missing-licenses.txt"),
    /** Starting point for meta-data development. */
    XML_TEMPLATE("manifest-template.xml"),
    /** Describes the directories in the source. */
    DIRECTORIES_REPORT("directories.txt");

    /** Conventional name for the result. */
    private final String name;

    /**
     * Constructs an instance.
     * @param name not null
     */
    private Result(final String name) {
        this.name = name;
    }

    /**
     * Gets the conventional name for this result.
     * @return not null
     */
    public String getName() {
        return name;
    }

    /**
     * Creates the conventional file for storage of this result.
     * @param directory not null
     * @return conventional file within directory
     */
    public File within(final File directory) {
        return new File(directory, getName());
    }
}