org.lsst.gruth.jutils

Class HollowParm<T extends Serializable>

java.lang.Object

org.lsst.gruth.jutils.HollowParm<T>

Type Parameters:

T - the Type of the object the HollowParm stands for.

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ArrayParm, BoolParm, DblParm, IntParm, ListParm, MapParm, NamedRefParm, StringParm, ValParm

public abstract class HollowParm<T extends Serializable>
extends Object
implements Serializable, Cloneable

(could not re-use java.lang.Reference) A Placeholder for a parameter value (for constructor or method). Such an object has a value that can be modified : it can be empty (then method isSet yields false) or initialized.

A special feature is about null values: normally setting up the value with null makes it uninitialized so making it nul AND initializes should be performed either by setNullValue or through modifyChecked which is a generic way of setting a value (with type control).

Author:

bamade

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	properties
protected boolean	readOnly
protected boolean	set
protected T	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HollowParm()
protected	HollowParm(T value)
protected	HollowParm(T value, Map<?,?> map)

Method Summary

Modifier and Type	Method and Description
HollowParm<T>	addProperties(Map.Entry<String,String>... entries)
void	clear()
HollowParm	clone() first level clone: object that are referenced are not duplicated
Properties	getProperties()
T	getValue()
abstract Class<T>	getValueClass()
boolean	isReadOnly()
boolean	isSet()
void	modifyChecked(T obj)
void	setNullValue()
void	setValue(T value)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

protected T extends Serializable value

set

protected boolean set

readOnly

protected boolean readOnly

properties

protected Properties properties

Constructor Detail

HollowParm

protected HollowParm()

HollowParm

protected HollowParm(T value)

HollowParm

protected HollowParm(T value,
                     Map<?,?> map)

Method Detail

getProperties

public Properties getProperties()

getValue

public T getValue()

setValue

public void setValue(T value)

setNullValue

public void setNullValue()

clear

public void clear()

modifyChecked

public void modifyChecked(T obj)

isSet

public boolean isSet()

isReadOnly

public boolean isReadOnly()

toString

public String toString()

Overrides:

toString in class Object

getValueClass

public abstract Class<T> getValueClass()

addProperties

public HollowParm<T> addProperties(Map.Entry<String,String>... entries)

clone

public HollowParm clone()

first level clone: object that are referenced are not duplicated

Overrides:

clone in class Object

Returns:

a clone of the object