[portal-commits] JBoss Portal SVN: r9198 - in branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state: structural and 1 other directory.

Author: julien(a)jboss.com Date: 2007-11-29 09:09:26 -0500 (Thu, 29 Nov 2007) New Revision: 9198 Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChange.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChangeEvent.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateModification.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralState.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateContext.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateModification.java Log: minor javadoc Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChange.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChange.java 2007-11-29 13:53:02 UTC (rev 9197) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChange.java 2007-11-29 14:09:26 UTC (rev 9198) @@ -23,6 +23,10 @@ package org.jboss.portal.presentation.model.state; /** + * A change in the state of the model. The change is the association of a target id and a modification. + * The target id refers to an object in the structural state context and the modification is a modification + * of its state. Note that the modification could also modify the state of other objects. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ @@ -51,11 +55,21 @@ this.modification = modification; } + /** + * Returns the target id of the change. + * + * @return the target id + */ public String getTargetId() { return targetId; } + /** + * Returns the modification operated on the target id. + * + * @return the modification + */ public M getModification() { return modification; Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChangeEvent.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChangeEvent.java 2007-11-29 13:53:02 UTC (rev 9197) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateChangeEvent.java 2007-11-29 14:09:26 UTC (rev 9198) @@ -25,6 +25,8 @@ import org.jboss.portal.presentation.model.ModelEvent; /** + * Signals a state change occured. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ @@ -45,6 +47,11 @@ this.change = change; } + /** + * Returns the state change that occured. + * + * @return the state change + */ public StateChange getChange() { return change; Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateModification.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateModification.java 2007-11-29 13:53:02 UTC (rev 9197) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/StateModification.java 2007-11-29 14:09:26 UTC (rev 9198) @@ -23,6 +23,8 @@ package org.jboss.portal.presentation.model.state; /** + * An abstract class for the modification of state. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralState.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralState.java 2007-11-29 13:53:02 UTC (rev 9197) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralState.java 2007-11-29 14:09:26 UTC (rev 9198) @@ -29,6 +29,8 @@ import java.util.List; /** + * The structural state. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ */ Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateContext.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateContext.java 2007-11-29 13:53:02 UTC (rev 9197) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateContext.java 2007-11-29 14:09:26 UTC (rev 9198) @@ -99,11 +99,7 @@ void move(String objectId, String parentId) throws StateChangeVetoException, StateException, IllegalArgumentException; /** - * Update the state of a specified object. The <code>Map</code> values are interpreted as follow: - * <ul> - * <li>Each non null value will replace an existing value of create a new one</li> - * <li>Each null value will destroy an existing value</li> - * </ul> + * Update the state of a specified object. * * @param objectId the id of the object to udpate * @param changes the changes Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateModification.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateModification.java 2007-11-29 13:53:02 UTC (rev 9197) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model/state/structural/StructuralStateModification.java 2007-11-29 14:09:26 UTC (rev 9198) @@ -27,6 +27,8 @@ import java.util.Map; /** + * Specification of state modification for structural state. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 630 $ */ @@ -37,6 +39,13 @@ { } + /** + * Update the properties portion of the state. The <code>Map</code> values are interpreted as follow: + * <ul> + * <li>Each non null value will replace an existing value of create a new one</li> + * <li>Each null value will destroy an existing value</li> + * </ul> + */ public final static class SetProperties extends StructuralStateModification { @@ -54,6 +63,10 @@ this.changes = changes; } + /** + * + * @return + */ public Map<String, String> getChanges() { return changes;