/hudson-core/src/main/java/hudson/slaves/NodeSpecific.java

 1/*
 2 * The MIT License
 3 *
 4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Tom Huybrechts
 5 *
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25package hudson.slaves;
26
27import hudson.model.Node;
28import hudson.model.EnvironmentSpecific;
29import hudson.model.TaskListener;
30import java.io.IOException;
31
32/**
33 * Represents any concept that can be adapted for a node.
34 *
35 * Mainly for documentation purposes.
36 *
37 * @author huybrechts
38 * @since 1.286
39 * @see EnvironmentSpecific
40 * @param <T>
41 *      Concrete type that represents the thing that can be adapted.
42 */
43public interface NodeSpecific<T extends NodeSpecific<T>> {
44    /**
45     * Returns a specialized copy of T for functioning in the given node.
46     */
47    T forNode(Node node, TaskListener log) throws IOException, InterruptedException;
48}