com.anrisoftware.sscontrol.scripts.mklink.MkLinkFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sscontrol-scripts-unix Show documentation

Collection of Unix scripts.

The newest version!

/*
 * Copyright 2014-2015 Erwin Müller 
 *
 * This file is part of sscontrol-scripts-unix.
 *
 * sscontrol-scripts-unix is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * sscontrol-scripts-unix is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with sscontrol-scripts-unix. If not, see .
 */
package com.anrisoftware.sscontrol.scripts.mklink;

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

import com.anrisoftware.globalpom.exec.runcommands.RunCommands;
import com.anrisoftware.globalpom.threads.api.Threads;

/**
 * Factory to create links to files.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface MkLinkFactory {

    /**
     * Creates to links to files.
     *
     * @param args
     *            the {@link Map} arguments:
     *            
     *            {@code runCommands} optionally, set to the
     *            {@link RunCommands} to record the command.
     *
     *            
{@code command} the create link command, for example
     *            {@code "/usr/bin/ln".}
     *
     *            
{@code files} the source {@link File} or {@link List} of
     *            files, each source file must have a corresponding target.
     *
     *            
{@code targets} the target {@link File} or {@link List} of
     *            files.
     *
     *            
{@code override} optionally, set to {@code true} to
     *            override the targets.
     *            
     *
     * @param parent
     *            the {@link Object} parent script.
     *
     * @param threads
     *            the {@link Threads} pool.
     *
     * @return the {@link MkLink}.
     */
    MkLink create(Map args, Object parent, Threads threads);
}