Revision: 431 http://skycastle.svn.sourceforge.net/skycastle/?rev=431&view=rev Author: zzorn Date: 2008-04-02 21:08:02 -0700 (Wed, 02 Apr 2008) Log Message: ----------- A bit of commenting and reformatting and small fixes Modified Paths: -------------- trunk/skycastle/modules/core/src/main/java/org/skycastle/kernel/KernelNode.java trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionFinishedMessage.java trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionInvocationFailedMessage.java trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStartedMessage.java trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStatusChangeMessage.java trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionUpdateMessage.java Modified: trunk/skycastle/modules/core/src/main/java/org/skycastle/kernel/KernelNode.java =================================================================== --- trunk/skycastle/modules/core/src/main/java/org/skycastle/kernel/KernelNode.java 2008-04-03 03:54:46 UTC (rev 430) +++ trunk/skycastle/modules/core/src/main/java/org/skycastle/kernel/KernelNode.java 2008-04-03 04:08:02 UTC (rev 431) @@ -1,16 +1,18 @@ package org.skycastle.kernel; +import org.skycastle.core.GameObject; import org.skycastle.core.GameObjectId; import org.skycastle.kernel.messaging.MessageHandler; /** * Something that can recieve and send messages to other nodes. Forms the core of all {@link - * org.skycastle.core.GameObject}s. + * GameObject}s. * <p/> * Allows screening incoming messages to check if they are accepted by this node, and handling the messages with * registered handlers. + * + * @deprecated use {@link GameObject} instead. */ -// REFACTOR: This should probably be the new GameObject. public interface KernelNode extends MessageHandler { Modified: trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionFinishedMessage.java =================================================================== --- trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionFinishedMessage.java 2008-04-03 03:54:46 UTC (rev 430) +++ trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionFinishedMessage.java 2008-04-03 04:08:02 UTC (rev 431) @@ -14,13 +14,29 @@ extends ActionUpdateMessage { + + //====================================================================== + // Private Constants + + private static final long serialVersionUID = 1L; + + //====================================================================== + // Public Methods + + //---------------------------------------------------------------------- + // Constructors + public ActionFinishedMessage( final GameObjectId updatedObjectId, final String memberIdentifier, final long actId ) { super( updatedObjectId, memberIdentifier, actId ); } + //---------------------------------------------------------------------- + // UpdateMessage Implementation + public void applyStateChangeToModel( final GameModel gameModel ) { throw new UnsupportedOperationException( "This method has not yet been implemented." ); // IMPLEMENT } + } Modified: trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionInvocationFailedMessage.java =================================================================== --- trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionInvocationFailedMessage.java 2008-04-03 03:54:46 UTC (rev 430) +++ trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionInvocationFailedMessage.java 2008-04-03 04:08:02 UTC (rev 431) @@ -6,24 +6,49 @@ /** * Indicates that an {@link org.skycastle.messaging.modifications.action.InvokeActionMessage} failed for some reason. * - * @author Hans H\xE4ggstr\xF6m + * @author Hans H�ggstr�m */ public final class ActionInvocationFailedMessage extends ActionUpdateMessage { + + //====================================================================== + // Private Fields + private final String myFailureReason; - public ActionInvocationFailedMessage( final GameObjectId updatedObjectId, final String memberIdentifier, final long actId, final String failureReason ) + //====================================================================== + // Private Constants + + private static final long serialVersionUID = 1L; + + //====================================================================== + // Public Methods + + //---------------------------------------------------------------------- + // Constructors + + public ActionInvocationFailedMessage( final GameObjectId updatedObjectId, + final String memberIdentifier, + final long actId, + final String failureReason ) { super( updatedObjectId, memberIdentifier, actId ); myFailureReason = failureReason; } + //---------------------------------------------------------------------- + // UpdateMessage Implementation + + public void applyStateChangeToModel( final GameModel gameModel ) { throw new UnsupportedOperationException( "This method has not yet been implemented." ); // IMPLEMENT } + //---------------------------------------------------------------------- + // Other Public Methods + /** * @return the reason why the action invocation failed. */ @@ -31,4 +56,5 @@ { return myFailureReason; } + } Modified: trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStartedMessage.java =================================================================== --- trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStartedMessage.java 2008-04-03 03:54:46 UTC (rev 430) +++ trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStartedMessage.java 2008-04-03 04:08:02 UTC (rev 431) @@ -4,18 +4,35 @@ import org.skycastle.core.clientside.GameModel; /** - * @author Hans H\xE4ggstr\xF6m + * @author Hans H�ggstr�m */ public final class ActionStartedMessage extends ActionUpdateMessage { + + //====================================================================== + // Private Constants + + private static final long serialVersionUID = 1L; + + //====================================================================== + // Public Methods + + //---------------------------------------------------------------------- + // Constructors + public ActionStartedMessage( final GameObjectId updatedObjectId, final String memberIdentifier, final long actId ) { super( updatedObjectId, memberIdentifier, actId ); } + //---------------------------------------------------------------------- + // UpdateMessage Implementation + + public void applyStateChangeToModel( final GameModel gameModel ) { throw new UnsupportedOperationException( "This method has not yet been implemented." ); // IMPLEMENT } + } Modified: trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStatusChangeMessage.java =================================================================== --- trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStatusChangeMessage.java 2008-04-03 03:54:46 UTC (rev 430) +++ trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionStatusChangeMessage.java 2008-04-03 04:08:02 UTC (rev 431) @@ -9,16 +9,36 @@ /** * An update on the progress of some long running action. * - * @author Hans H\xE4ggstr\xF6m + * @author Hans H\xEF\xBF\xBDggstr�m */ public final class ActionStatusChangeMessage extends ActionUpdateMessage { + + //====================================================================== + // Private Fields + private final String myStatus; private final long myEstimatedCompletionTime; private final float myCompletitionPercentage; - public ActionStatusChangeMessage( final GameObjectId updatedObjectId, final String memberIdentifier, final long actId, final String status, final long estimatedCompletionTime, final float completitionPercentage ) + //====================================================================== + // Private Constants + + private static final long serialVersionUID = 1L; + + //====================================================================== + // Public Methods + + //---------------------------------------------------------------------- + // Constructors + + public ActionStatusChangeMessage( final GameObjectId updatedObjectId, + final String memberIdentifier, + final long actId, + final String status, + final long estimatedCompletionTime, + final float completitionPercentage ) { super( updatedObjectId, memberIdentifier, actId ); myStatus = status; @@ -26,11 +46,10 @@ myCompletitionPercentage = completitionPercentage; } - public float getCompletitionPercentage() - { - return myCompletitionPercentage; - } + //---------------------------------------------------------------------- + // Message Implementation + @Override public ValidationError validate( final Set<String> allowedContainedTypes, final String errorPrefix ) { @@ -44,18 +63,33 @@ return validationError; } + //---------------------------------------------------------------------- + // UpdateMessage Implementation + + + public void applyStateChangeToModel( final GameModel gameModel ) + { + throw new UnsupportedOperationException( "This method has not yet been implemented." ); // IMPLEMENT + } + + //---------------------------------------------------------------------- + // Other Public Methods + + public float getCompletitionPercentage() + { + return myCompletitionPercentage; + } + + public String getStatus() { return myStatus; } + public long getEstimatedCompletionTime() { return myEstimatedCompletionTime; } - public void applyStateChangeToModel( final GameModel gameModel ) - { - throw new UnsupportedOperationException( "This method has not yet been implemented." ); // IMPLEMENT - } } Modified: trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionUpdateMessage.java =================================================================== --- trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionUpdateMessage.java 2008-04-03 03:54:46 UTC (rev 430) +++ trunk/skycastle/modules/core/src/main/java/org/skycastle/messaging/updates/action/ActionUpdateMessage.java 2008-04-03 04:08:02 UTC (rev 431) @@ -4,13 +4,25 @@ import org.skycastle.messaging.updates.MemberUpdateMessage; /** - * @author Hans H\xE4ggstr\xF6m + * Contains common data for action update messages. + * + * @author Hans H�ggstr�m */ public abstract class ActionUpdateMessage extends MemberUpdateMessage { + + //====================================================================== + // Private Fields + private final long myActId; + //====================================================================== + // Public Methods + + //---------------------------------------------------------------------- + // Constructors + public ActionUpdateMessage( final GameObjectId updatedObjectId, final String memberIdentifier, final long actId ) { super( updatedObjectId, memberIdentifier ); @@ -18,8 +30,12 @@ myActId = actId; } + //---------------------------------------------------------------------- + // Other Public Methods + public final long getActId() { return myActId; } + } This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.