org.simbrain.workspace.updater

Class ComponentUpdatePart

java.lang.Object

org.simbrain.workspace.updater.ComponentUpdatePart

public class ComponentUpdatePart
extends java.lang.Object

Represents a single part of a component update. (Note: Component updates involving multiple parts have not been tested yet. Theoretically the idea is that a type of workspace component would override getComponentParts and return a set of update tasks. I believe they must be able to be separately run in a given iteration but again, this has not been tested (JKY).

Author:

Matt Watson

Constructor Summary

Constructors

Constructor and Description
ComponentUpdatePart(WorkspaceComponent parent, java.lang.Runnable runnable, java.lang.String description) Creates a new instance with the given parent, runnable, description using this object as the lock.
ComponentUpdatePart(WorkspaceComponent parent, java.lang.Runnable runnable, java.lang.String description, java.lang.Object lock) Creates a new instance with the given parent, runnable, description and lock.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the description for this part.
(package private) java.lang.Object	getLock() Returns the lock for this object.
WorkspaceComponent	getParent() Returns the parent of this component.
(package private) java.lang.Runnable	getUpdate(CompletionSignal signal) Get's a runnable that counts down the latch after completion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentUpdatePart

public ComponentUpdatePart(WorkspaceComponent parent,
                           java.lang.Runnable runnable,
                           java.lang.String description,
                           java.lang.Object lock)

Creates a new instance with the given parent, runnable, description and lock.

Parameters:

parent - The parent component.

runnable - The task to execute.

description - The description of the part.

lock - The lock to use.

ComponentUpdatePart

public ComponentUpdatePart(WorkspaceComponent parent,
                           java.lang.Runnable runnable,
                           java.lang.String description)

Creates a new instance with the given parent, runnable, description using this object as the lock.

Parameters:

parent - The parent component.

runnable - The task to execute.

description - The description of the part.

Method Detail

getParent

public WorkspaceComponent getParent()

Returns the parent of this component.

Returns:

the parent of this component.

getLock

java.lang.Object getLock()

Returns the lock for this object.

Returns:

the lock for this object.

getDescription

public java.lang.String getDescription()

Returns the description for this part.

Returns:

the description for this part.

getUpdate

java.lang.Runnable getUpdate(CompletionSignal signal)

Get's a runnable that counts down the latch after completion.

Parameters:

signal - the latch to count down on.

Returns:

The runnable to execute.