net.sourceforge.xwing
Class DefaultValueSourceSink

java.lang.Object
  net.sourceforge.xwing.AbstractSourceSink
      net.sourceforge.xwing.DefaultValueSourceSink

All Implemented Interfaces:

SourceSink

public class DefaultValueSourceSink

extends AbstractSourceSink

A SourceSink that channels a value from some other SourceSink. When the value of that SourceSink is null, a default value is retrieved from another SourceSink.

Version:

$Revision: 1.2 $

Author:

Scott Howlett

Constructor Summary

DefaultValueSourceSink(SourceSink valueSS, SourceSink defaultSS)
Create a new DefaultValueSourceSink.

Method Summary

Object	get() Retrieve some value.
boolean	isUsingDefault() Is this SourceSink currently using its default value?
void	restoreDefault() Cause this SourceSink to revert to its default value.
void	set(Object newValue) Store some value.

Methods inherited from class net.sourceforge.xwing.AbstractSourceSink

addChangeListener, fireStateChanged, removeChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultValueSourceSink

public DefaultValueSourceSink(SourceSink valueSS,
                              SourceSink defaultSS)

Create a new DefaultValueSourceSink.

Parameters:

valueSS - the SourceSink that values are read from and written to.

defaultSS - A SourceSink that values are read from if the value held by valueSS is null. defaultSS is never written to.

Method Detail

get

public Object get()

Description copied from interface: SourceSink

Retrieve some value.

Returns:

a value.

set

public void set(Object newValue)

Description copied from interface: SourceSink

Store some value.

Parameters:

newValue - The value to be stored. In general, if a value is stored via set(), the value retrieved by a subsequent get() call will equal the set value as defined by the value's equals() method.

isUsingDefault

public boolean isUsingDefault()

Is this SourceSink currently using its default value?

restoreDefault

public void restoreDefault()

Cause this SourceSink to revert to its default value.