buffer

Class ObjectWithParents<PC extends ObjectWithParents>

java.lang.Object

buffer.ObjectWithParents<PC>

public abstract class ObjectWithParents<PC extends ObjectWithParents>
extends java.lang.Object

A ObjectWithParents, i.e., an object-with-parents, is an object that is (possibly partially) defined as a list of objects of the same type.

Constructor Summary

Constructors

Constructor and Description
ObjectWithParents()

Method Summary

Methods

Modifier and Type	Method and Description
PC	getCanonicalObjectOfParent(PC prt) Returns the canonical version of the specified parent of this object.
abstract PC	getPrimaryChild() Returns the primary child of this object.
abstract java.lang.Iterable<PC>	getSecondaryChildren() Returns the secondary children of this object.
void	removeParentFromPrimaryChild(PC prt)
void	unwatch()
void	watch()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectWithParents

public ObjectWithParents()

Method Detail

getCanonicalObjectOfParent

public PC getCanonicalObjectOfParent(PC prt)

Returns the canonical version of the specified parent of this object. If there is no canonical version of the specified object, then the specified object becomes the canonical version; it is therefore stored in this object as a canonical object.

Parameters:

prt - the parent of this object.

Returns:

the canonical version of prt, i.e., either a copy of prt if this copy exists or prt otherwise.

removeParentFromPrimaryChild

public void removeParentFromPrimaryChild(PC prt)

getPrimaryChild

public abstract PC getPrimaryChild()

Returns the primary child of this object.

Returns:

the child of this object if any, null otherwise.

getSecondaryChildren

public abstract java.lang.Iterable<PC> getSecondaryChildren()

Returns the secondary children of this object.

Returns:

the list of secondary children of this object.

watch

public void watch()

unwatch

public void unwatch()