[portal-commits] JBoss Portal SVN: r10463 - in modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation: protocol and 1 other directory.

Author: julien(a)jboss.com Date: 2008-04-01 16:55:11 -0400 (Tue, 01 Apr 2008) New Revision: 10463 Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model2/ui/UIWindow.java modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerAction.java modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerResponse.java modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/StreamResponse.java modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectAction.java modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectResponse.java Log: minor tweaks Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model2/ui/UIWindow.java =================================================================== --- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model2/ui/UIWindow.java 2008-04-01 20:48:27 UTC (rev 10462) +++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model2/ui/UIWindow.java 2008-04-01 20:55:11 UTC (rev 10463) @@ -32,7 +32,7 @@ public interface UIWindow extends UIObject { /** - * Returns the window state of the window or null if it does not exist. + * Returns the window state of the window or null if it does not exist. It is a convenient wrapper * * @return the window state */ Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerAction.java =================================================================== --- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerAction.java 2008-04-01 20:48:27 UTC (rev 10462) +++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerAction.java 2008-04-01 20:55:11 UTC (rev 10463) @@ -23,8 +23,10 @@ package org.jboss.portal.presentation.protocol; /** + * The base class for an action on the server. + * * @author <a href="mailto:sshah@redhat.com">Sohil Shah</a> - * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> */ public abstract class ServerAction { Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerResponse.java =================================================================== --- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerResponse.java 2008-04-01 20:48:27 UTC (rev 10462) +++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ServerResponse.java 2008-04-01 20:55:11 UTC (rev 10463) @@ -23,6 +23,8 @@ package org.jboss.portal.presentation.protocol; /** + * The base class for a response from the server. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ */ Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/StreamResponse.java =================================================================== --- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/StreamResponse.java 2008-04-01 20:48:27 UTC (rev 10462) +++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/StreamResponse.java 2008-04-01 20:55:11 UTC (rev 10463) @@ -26,18 +26,14 @@ /** * @author <a href="mailto:sshah@redhat.com">Sohil Shah</a> - * */ public class StreamResponse extends ServerResponse { - /** - * - */ + + /** . */ private String contentType = null; - /** - * - */ + /** . */ private InputStream is = null; /** @@ -47,6 +43,8 @@ */ public StreamResponse(String contentType, InputStream is) { + + this.contentType = contentType; this.is = is; } Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectAction.java =================================================================== --- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectAction.java 2008-04-01 20:48:27 UTC (rev 10462) +++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectAction.java 2008-04-01 20:55:11 UTC (rev 10463) @@ -23,20 +23,39 @@ package org.jboss.portal.presentation.protocol; /** + * An abstract class that defines an action that targets a user interface object. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ */ -public class UIObjectAction extends ServerAction +public abstract class UIObjectAction extends ServerAction { - /** . */ + /** The id of the target object. */ private final String targetId; - public UIObjectAction(String targetId) + /** + * Constructor for an user interface object action. + * + * @param targetId the id of the target user interface object + * @throws IllegalArgumentException if the target id is null + */ + public UIObjectAction(String targetId) throws IllegalArgumentException { + if (targetId == null) + { + throw new IllegalArgumentException("The target user interface object must not be null"); + } + + // this.targetId = targetId; } + /** + * The user interface target id. + * + * @return the target id + */ public String getTargetId() { return targetId; Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectResponse.java =================================================================== --- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectResponse.java 2008-04-01 20:48:27 UTC (rev 10462) +++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/UIObjectResponse.java 2008-04-01 20:55:11 UTC (rev 10463) @@ -23,20 +23,39 @@ package org.jboss.portal.presentation.protocol; /** + * An abstract class that defines a response that targets a user interface object. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ */ -public class UIObjectResponse extends ServerResponse +public abstract class UIObjectResponse extends ServerResponse { - /** . */ + /** The id of the target object. */ private final String targetId; - public UIObjectResponse(String targetId) + /** + * Constructor for an user interface object response. + * + * @param targetId the id of the target user interface object + * @throws IllegalArgumentException if the target id is null + */ + public UIObjectResponse(String targetId) throws IllegalArgumentException { + if (targetId == null) + { + throw new IllegalArgumentException("The target user interface object must not be null"); + } + + // this.targetId = targetId; } + /** + * The user interface target id. + * + * @return the target id + */ public String getTargetId() { return targetId;