File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\WorkspaceBrowser.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2013, CloudBees, Intl., Nicolas De loof
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
25 package hudson.model;
26
27 import hudson.ExtensionPoint;
28 import hudson.FilePath;
29 import hudson.slaves.WorkspaceList;
30
31 import javax.annotation.CheckForNull;
32
33 /**
34 * Allows to access a workspace as an alternative to online build node.
35 * <p>
36 * Primary use case is {@link hudson.slaves.Cloud} implementations that don't keep the slave
37 * node online to browse workspace, but maintain a copy of node workspace on master.
38 *
39 * @author <a href="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
40 * @since 1.502
41 */
42 public abstract class WorkspaceBrowser implements ExtensionPoint {
43
44 private final WorkspaceList workspaceList = new WorkspaceList();
45
46 /**
47 * Provide access to job's workspace
48 * @param job
49 * @return <code>null</code> if this WorkspaceBrowser don't have a workspace for this job
50 */
51 public abstract @CheckForNull FilePath getWorkspace(Job job);
52
53 /**
54 * Gets the object that coordinates the workspace allocation.
55 */
56 /* package */ final WorkspaceList getWorkspaceList() {
57 return workspaceList;
58 }
59 }
60