org.trianacode.taskgraph.clipin

Interface ClipIn

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

HistoryClipIn

All Known Implementing Classes:

DefaultHistoryClipIn, GEODataClipIn, MessageClipIn, TimerClipIn

public interface ClipIn
extends java.io.Serializable

ClipIn is an Interface that can be implemented by any Object to allow it to be added into and carried by a TrianaType data Object. ClipIns carry optional information that are not essential to the operation of the data Object but which may be required by certain Units.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clones the ClipIn to an identical one.
void	finalizeAttach(AttachInfo info) This method is called when the clip-in is removed from a task's clip-in bucket.
void	initializeAttach(AttachInfo info) This method is called before the clip-in enters a task's clip-in bucket.

Method Detail

initializeAttach

void initializeAttach(AttachInfo info)

This method is called before the clip-in enters a task's clip-in bucket. This occurs when either the data it is attached to is input by the task, or when the unit directly adds the clip-in to its bucket.

Parameters:

info - info about the task the clip-in is being attached to

finalizeAttach

void finalizeAttach(AttachInfo info)

This method is called when the clip-in is removed from a task's clip-in bucket. This occurs when either the data it is attached to is output by the task, or when the unit directly remove the clip-in from its bucket.

Parameters:

info - info about the task the clip-in is being removed from

clone

java.lang.Object clone()

Clones the ClipIn to an identical one. This is a copy by value, not by reference. This method must be implemented for each class in a way that depends on the contents of the ClipIn.

Returns:

a copy by value of the current ClipIn