/hudson-test-framework/src/main/java/org/jvnet/hudson/test/TestBuilder.java

 1/*
 2 * The MIT License
 3 * 
 4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
 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 */
24package org.jvnet.hudson.test;
25
26import hudson.tasks.Builder;
27import hudson.model.Descriptor;
28import hudson.model.AbstractBuild;
29import hudson.model.BuildListener;
30import hudson.Launcher;
31
32import java.io.IOException;
33
34/**
35 * Partial {@link Builder} implementation for writing a one-off throw-away builder used during tests.
36 *
37 * <p>
38 * Because this builder tends to be written as an inner class, this builder doesn't write itself
39 * to a disk when persisted. Configuration screen won't work, either.
40 *
41 * @author Kohsuke Kawaguchi
42 */
43public abstract class TestBuilder extends Builder {
44
45    public abstract boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException;
46
47    public Descriptor<Builder> getDescriptor() {
48        throw new UnsupportedOperationException();
49    }
50
51    private Object writeReplace() { return new Object(); }
52}