Forkable.java

/*
 * Copyright (c) 2009, Paul Merlin. All Rights Reserved.
 *
 * Licensed 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.swing.on.steroids.forking;

import java.io.File;
import java.util.List;
import java.util.Map;

public interface Forkable {

    /**
     * @return Name used for logging purpose.
     */
    String name();

    /**
     * @return Forkable command as a collection of String.
     */
    List<String> command();

    /**
     * @return Wanted working directory. This can be null, in this case, the current working directory will be used.
     */
    File workingDirectory();

    /**
     * @return The additional environment variables to user.
     */
    Map<String, String> environment();
}