Top Description Inners Fields Constructors Methods
org.mortbay.component

public Class Container

extends Object
Class Inheritance
Imports
java.util.EventListener, org.mortbay.log.Log, org.mortbay.util.LazyList
Container. This class allows a containment events to be generated from update methods. The style of usage is: 
  public void setFoo(Foo foo)
  {
      getContainer().update(this,this.foo,foo,"foo");
      this.foo=foo;
  }

  public void setBars(Bar[] bars)
  {
      getContainer().update(this,this.bars,bars,"bar");
      this.bars=bars;
  }
Author
gregw

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
Container.Listener

Listener.

public static class
Container.Relationship

A Container event.

Field Summary

Modifier and TypeField and Description
private Object
_listeners

Constructor Summary

AccessConstructor and Description
public
Container()

Method Summary

Modifier and TypeMethod and Description
private void
add(Object parent, Object child, String relationship)

Add a parent child relationship

public void
addBean(Object obj)

public synchronized void
addEventListener(Container.Listener listener)

private void
remove(Object parent, Object child, String relationship)

remove a parent child relationship

public void
removeBean(Object obj)

public synchronized void
removeEventListener(Container.Listener listener)

public synchronized void
update(Object
The parent of the child.
parent, Object
The previous value of the child. If this is non null and differs from child, then a remove event is generated.
oldChild, final Object
The current child. If this is non null and differs from oldChild, then an add event is generated.
child, String
The name of the relationship
relationship)

Update single parent to child relationship.

public synchronized void
update(Object
The parent of the child.
parent, Object
The previous value of the child. If this is non null and differs from child, then a remove event is generated.
oldChild, final Object
The current child. If this is non null and differs from oldChild, then an add event is generated.
child, String
The name of the relationship
relationship, boolean
If true add/remove is called for the new/old children as well as the relationships
addRemove)

Update single parent to child relationship.

public synchronized void
update(Object
The parent of the child.
parent, Object[]
The previous array of children. A remove event is generated for any child in this array but not in the children array. This array is modified and children that remain in the new children array are nulled out of the old children array.
oldChildren, final Object[]
The current array of children. An add event is generated for any child in this array but not in the oldChildren array.
children, String
The name of the relationship
relationship)

Update multiple parent to child relationship.

public synchronized void
update(Object
The parent of the child.
parent, Object[]
The previous array of children. A remove event is generated for any child in this array but not in the children array. This array is modified and children that remain in the new children array are nulled out of the old children array.
oldChildren, final Object[]
The current array of children. An add event is generated for any child in this array but not in the oldChildren array.
children, String
The name of the relationship
relationship, boolean
If true add/remove is called for the new/old children as well as the relationships
addRemove)

Update multiple parent to child relationship.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_listenersback to summary
private Object _listeners

Constructor Detail

Containerback to summary
public Container()

Method Detail

addback to summary
private void add(Object parent, Object child, String relationship)

Add a parent child relationship

addBeanback to summary
public void addBean(Object obj)
addEventListenerback to summary
public synchronized void addEventListener(Container.Listener listener)
removeback to summary
private void remove(Object parent, Object child, String relationship)

remove a parent child relationship

removeBeanback to summary
public void removeBean(Object obj)
removeEventListenerback to summary
public synchronized void removeEventListener(Container.Listener listener)
updateback to summary
public synchronized void update(Object parent, Object oldChild, final Object child, String relationship)

Update single parent to child relationship.

Parameters
parent:Object

The parent of the child.

oldChild:Object

The previous value of the child. If this is non null and differs from child, then a remove event is generated.

child:Object

The current child. If this is non null and differs from oldChild, then an add event is generated.

relationship:String

The name of the relationship

updateback to summary
public synchronized void update(Object parent, Object oldChild, final Object child, String relationship, boolean addRemove)

Update single parent to child relationship.

Parameters
parent:Object

The parent of the child.

oldChild:Object

The previous value of the child. If this is non null and differs from child, then a remove event is generated.

child:Object

The current child. If this is non null and differs from oldChild, then an add event is generated.

relationship:String

The name of the relationship

addRemove:boolean

If true add/remove is called for the new/old children as well as the relationships

updateback to summary
public synchronized void update(Object parent, Object[] oldChildren, final Object[] children, String relationship)

Update multiple parent to child relationship.

Parameters
parent:Object

The parent of the child.

oldChildren:Object[]

The previous array of children. A remove event is generated for any child in this array but not in the children array. This array is modified and children that remain in the new children array are nulled out of the old children array.

children:Object[]

The current array of children. An add event is generated for any child in this array but not in the oldChildren array.

relationship:String

The name of the relationship

updateback to summary
public synchronized void update(Object parent, Object[] oldChildren, final Object[] children, String relationship, boolean addRemove)

Update multiple parent to child relationship.

Parameters
parent:Object

The parent of the child.

oldChildren:Object[]

The previous array of children. A remove event is generated for any child in this array but not in the children array. This array is modified and children that remain in the new children array are nulled out of the old children array.

children:Object[]

The current array of children. An add event is generated for any child in this array but not in the oldChildren array.

relationship:String

The name of the relationship

addRemove:boolean

If true add/remove is called for the new/old children as well as the relationships

org.mortbay.component back to summary

public Interface Container.Listener

extends EventListener
Listener. A listener for Container events.

Method Summary

Modifier and TypeMethod and Description
public void
add(Container.Relationship relationship)

public void
addBean(Object bean)

public void
remove(Container.Relationship relationship)

public void
removeBean(Object bean)

Method Detail

addback to summary
public void add(Container.Relationship relationship)
addBeanback to summary
public void addBean(Object bean)
removeback to summary
public void remove(Container.Relationship relationship)
removeBeanback to summary
public void removeBean(Object bean)
org.mortbay.component back to summary

public Class Container.Relationship

extends Object
Class Inheritance
A Container event.
See Also
Listener

Field Summary

Modifier and TypeField and Description
private Object
_child

private Container
_container

private Object
_parent

private String
_relationship

Constructor Summary

AccessConstructor and Description
private
Relationship(Container container, Object parent, Object child, String relationship)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Object
getChild()

public Container
getContainer()

public Object
getParent()

public String
getRelationship()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_childback to summary
private Object _child
_containerback to summary
private Container _container
_parentback to summary
private Object _parent
_relationshipback to summary
private String _relationship

Constructor Detail

Relationshipback to summary
private Relationship(Container container, Object parent, Object child, String relationship)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getChildback to summary
public Object getChild()
getContainerback to summary
public Container getContainer()
getParentback to summary
public Object getParent()
getRelationshipback to summary
public String getRelationship()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.