org.sapia.util.xml.confix
Class CreationStatus

java.lang.Object
  |
  +--org.sapia.util.xml.confix.CreationStatus

public class CreationStatus

extends Object

Models a "creation status". A creation status encapsulates:

• The object that is created by a given object factory;
• A flag that indicates if the created instance was assigned to its parent - through a set/add method.

An instance of this class is not created through a constructor; rather, it is created as such:

 CreationStatus stat = CreationStatus.create(someObject);
 

Author:

Yanick Duchesne

Copyright:

Copyright © 2002-2003 Sapia Open Source Software. All Rights Reserved.

License:

Read the license.txt file of the jar or visit the license page at the Sapia OSS web site

Method Summary

CreationStatus	assigned(boolean assigned) Sets this instance's "assigned" status.
static CreationStatus	create(Object created) Returns a CreationStatus that encapsulates the given instance.
Object	getCreated() Returns the created object.
void	setCreated(Object created) Sets the object that was created.
boolean	wasAssigned() Returns true if the encapsulated object was assigned to its parent.

Methods inherited from class java.lang.Object

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

Method Detail

getCreated

public Object getCreated()

Returns the created object.

Returns:

an Object.

setCreated

public void setCreated(Object created)

Sets the object that was created.

wasAssigned

public boolean wasAssigned()

Returns true if the encapsulated object was assigned to its parent.

Returns:

true if the encapsulated object was assigned to its parent.

assigned

public CreationStatus assigned(boolean assigned)

Sets this instance's "assigned" status.

Parameters:

assigned - if true, indicates that the object encapsulated within this instance was assigned to its parent.

create

public static CreationStatus create(Object created)

Returns a CreationStatus that encapsulates the given instance.

Parameters:

created - the created object.

Returns:

a CreationStatus.