/hudson-core/src/main/java/hudson/model/queue/WorkUnit.java
http://github.com/hudson/hudson · Java · 95 lines · 34 code · 11 blank · 50 comment · 0 complexity · c03febb4ffa4a0ea4620f30da036e727 MD5 · raw file
- /*
- * The MIT License
- *
- * Copyright (c) 2010, InfraDNA, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
- package hudson.model.queue;
- import hudson.model.Executor;
- import hudson.model.Queue;
- import hudson.model.Queue.Executable;
- import hudson.model.Queue.Task;
- import org.kohsuke.stapler.export.ExportedBean;
- /**
- * Represents a unit of hand-over to {@link Executor} from {@link Queue}.
- *
- * @author Kohsuke Kawaguchi
- * @since 1.377
- */
- @ExportedBean
- public final class WorkUnit {
- /**
- * Task to be executed.
- */
- //TODO: review and check whether we can do it private
- public final SubTask work;
- /**
- * Shared context among {@link WorkUnit}s.
- */
- //TODO: review and check whether we can do it private
- public final WorkUnitContext context;
- private volatile Executor executor;
- WorkUnit(WorkUnitContext context, SubTask work) {
- this.context = context;
- this.work = work;
- }
- public SubTask getWork() {
- return work;
- }
- public WorkUnitContext getContext() {
- return context;
- }
- /**
- * {@link Executor} running this work unit.
- * <p>
- * {@link Executor#getCurrentWorkUnit()} and {@link WorkUnit#getExecutor()}
- * form a bi-directional reachability between them.
- */
- public Executor getExecutor() {
- return executor;
- }
- public void setExecutor(Executor e) {
- executor = e;
- }
- /**
- * If the execution has already started, return the current executable.
- */
- public Executable getExecutable() {
- return executor!=null ? executor.getCurrentExecutable() : null;
- }
- /**
- * Is this work unit the "main work", which is the primary {@link SubTask}
- * represented by {@link Task} itself.
- */
- public boolean isMainWork() {
- return context.task==work;
- }
- }