first commit
This commit is contained in:
Jose Caban
@@ -0,0 +1,465 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
AbstractMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.AbstractMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="AbstractMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
PREV CLASS
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="AbstractMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class AbstractMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.AbstractMessage</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">ChangeLemmingFlowMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">ChangeSpeedMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">IdentificationMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">LevelFinishMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">NukeRequestMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">PauseMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">StatsMessage</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">UpdateMessage</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public abstract class <B>AbstractMessage</B><DT>extends java.lang.Object</DL>
|
||||
|
||||
<P>
|
||||
Class AbstractMessage: This class is the base for all network
|
||||
messages that will be sent between the client and the server. All
|
||||
of the more specific message classes will be derived from it and
|
||||
will add more and more spcific functionality onto the basics
|
||||
provided in this class.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (Apr. 8, 2004) - Created the AbstractMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0, Apr 8, 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg563g@mail.gatech.edu">Daniyar Zhanbekov</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#AbstractMessage()">AbstractMessage</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>AbstractMessage</code> instance.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#AbstractMessage(java.lang.String)">AbstractMessage</A></B>(java.lang.String type)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>AbstractMessage</code> instance.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#AbstractMessage(java.lang.String, java.lang.String)">AbstractMessage</A></B>(java.lang.String type,
|
||||
java.lang.String author)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>AbstractMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the name of the user that sent out the message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the message type.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the message type of the message string passed in.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A></B>(java.lang.String author)</CODE>
|
||||
|
||||
<BR>
|
||||
Gives message author a new value.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></B>(java.lang.String newType)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets a new message type.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>abstract java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="AbstractMessage()"><!-- --></A><H3>
|
||||
AbstractMessage</H3>
|
||||
<PRE>
|
||||
public <B>AbstractMessage</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>AbstractMessage</code> instance.
|
||||
<P>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="AbstractMessage(java.lang.String)"><!-- --></A><H3>
|
||||
AbstractMessage</H3>
|
||||
<PRE>
|
||||
public <B>AbstractMessage</B>(java.lang.String type)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>AbstractMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>type</CODE> - a <code>String</code> value</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="AbstractMessage(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
AbstractMessage</H3>
|
||||
<PRE>
|
||||
public <B>AbstractMessage</B>(java.lang.String type,
|
||||
java.lang.String author)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>AbstractMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>type</CODE> - a <code>String</code> value<DD><CODE>author</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="getMessageType()"><!-- --></A><H3>
|
||||
getMessageType</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>getMessageType</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the message type.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setMessageType(java.lang.String)"><!-- --></A><H3>
|
||||
setMessageType</H3>
|
||||
<PRE>
|
||||
protected final void <B>setMessageType</B>(java.lang.String newType)</PRE>
|
||||
<DL>
|
||||
<DD>Sets a new message type.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>newType</CODE> - a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getMessageType(java.lang.String)"><!-- --></A><H3>
|
||||
getMessageType</H3>
|
||||
<PRE>
|
||||
public static java.lang.String <B>getMessageType</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Returns the message type of the message string passed in.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getAuthor()"><!-- --></A><H3>
|
||||
getAuthor</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>getAuthor</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the name of the user that sent out the message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setAuthor(java.lang.String)"><!-- --></A><H3>
|
||||
setAuthor</H3>
|
||||
<PRE>
|
||||
public final void <B>setAuthor</B>(java.lang.String author)</PRE>
|
||||
<DL>
|
||||
<DD>Gives message author a new value.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>author</CODE> - a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public abstract java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
PREV CLASS
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="AbstractMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,372 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
ChangeLemmingFlowMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.ChangeLemmingFlowMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ChangeLemmingFlowMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ChangeLemmingFlowMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class ChangeLemmingFlowMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.ChangeLemmingFlowMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>ChangeLemmingFlowMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class ChangeLemmingFlowMessage: Sent to change lemming flow.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (April 08, 2004) - Created the ChangeSpeedMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0,April 08 , 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg284h@mail.gatech.edu">Andrew Knight</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html#ChangeLemmingFlowMessage(java.lang.String)">ChangeLemmingFlowMessage</A></B>(java.lang.String userName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>ChangeLemmingFlowMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html#getLemmingFlow()">getLemmingFlow</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Accessor for speed int</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html#setLemmingFlow(int)">setLemmingFlow</A></B>(int flow)</CODE>
|
||||
|
||||
<BR>
|
||||
Modifier for speed int</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="ChangeLemmingFlowMessage(java.lang.String)"><!-- --></A><H3>
|
||||
ChangeLemmingFlowMessage</H3>
|
||||
<PRE>
|
||||
public <B>ChangeLemmingFlowMessage</B>(java.lang.String userName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>ChangeLemmingFlowMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLemmingFlow()"><!-- --></A><H3>
|
||||
getLemmingFlow</H3>
|
||||
<PRE>
|
||||
public int <B>getLemmingFlow</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Accessor for speed int
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>int , speed</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLemmingFlow(int)"><!-- --></A><H3>
|
||||
setLemmingFlow</H3>
|
||||
<PRE>
|
||||
public void <B>setLemmingFlow</B>(int flow)</PRE>
|
||||
<DL>
|
||||
<DD>Modifier for speed int
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>flow</CODE> - , int for speed</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ChangeLemmingFlowMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,372 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
ChangeSpeedMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.ChangeSpeedMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ChangeSpeedMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ChangeSpeedMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class ChangeSpeedMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.ChangeSpeedMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>ChangeSpeedMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class ChangeSpeedMessage: Sent to change speed of game.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (April 08, 2004) - Created the ChangeSpeedMessage class.
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0,April 08 , 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg284h@mail.gatech.edu">Andrew Knight</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html#ChangeSpeedMessage(java.lang.String)">ChangeSpeedMessage</A></B>(java.lang.String userName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>ChangeSpeedMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html#getSpeed()">getSpeed</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Accessor for speed int.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html#setSpeed(int)">setSpeed</A></B>(int s)</CODE>
|
||||
|
||||
<BR>
|
||||
Modifier for speed int.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="ChangeSpeedMessage(java.lang.String)"><!-- --></A><H3>
|
||||
ChangeSpeedMessage</H3>
|
||||
<PRE>
|
||||
public <B>ChangeSpeedMessage</B>(java.lang.String userName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>ChangeSpeedMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - a <code>String</code> value.</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value.
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getSpeed()"><!-- --></A><H3>
|
||||
getSpeed</H3>
|
||||
<PRE>
|
||||
public int <B>getSpeed</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Accessor for speed int.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>int , speed</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setSpeed(int)"><!-- --></A><H3>
|
||||
setSpeed</H3>
|
||||
<PRE>
|
||||
public void <B>setSpeed</B>(int s)</PRE>
|
||||
<DL>
|
||||
<DD>Modifier for speed int.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>s</CODE> - , int for speed</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ChangeSpeedMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,351 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
ConnectionListener
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.ConnectionListener class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="ConnectionListener";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionListener.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class ConnectionListener</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.ConnectionListener</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Runnable</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>ConnectionListener</B><DT>extends java.lang.Object<DT>implements java.lang.Runnable</DL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html#ConnectionListener(int, long)">ConnectionListener</A></B>(int port,
|
||||
long timeout)</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html#getPort()">getPort</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> long</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html#getTimeout()">getTimeout</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> long</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html#getTimeTillTimeOut()">getTimeTillTimeOut</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html#run()">run</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
main thread establishes a server socket and accepts client</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html#stopListening()">stopListening</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="ConnectionListener(int, long)"><!-- --></A><H3>
|
||||
ConnectionListener</H3>
|
||||
<PRE>
|
||||
public <B>ConnectionListener</B>(int port,
|
||||
long timeout)</PRE>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>port</CODE> - p<DD><CODE>timeout</CODE> - t</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="run()"><!-- --></A><H3>
|
||||
run</H3>
|
||||
<PRE>
|
||||
public final void <B>run</B>()</PRE>
|
||||
<DL>
|
||||
<DD>main thread establishes a server socket and accepts client
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPort()"><!-- --></A><H3>
|
||||
getPort</H3>
|
||||
<PRE>
|
||||
public int <B>getPort</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>int</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getTimeout()"><!-- --></A><H3>
|
||||
getTimeout</H3>
|
||||
<PRE>
|
||||
public long <B>getTimeout</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>long</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getTimeTillTimeOut()"><!-- --></A><H3>
|
||||
getTimeTillTimeOut</H3>
|
||||
<PRE>
|
||||
public long <B>getTimeTillTimeOut</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>long</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="stopListening()"><!-- --></A><H3>
|
||||
stopListening</H3>
|
||||
<PRE>
|
||||
public void <B>stopListening</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ConnectionListener.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,329 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
IdentificationMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.IdentificationMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="IdentificationMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="IdentificationMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class IdentificationMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.IdentificationMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>IdentificationMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class IdentificationMessage: Sends username to other player.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (April 08, 2004) - Created the IdentifiationMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0,April 08 , 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg284h@mail.gatech.edu">Andrew Knight</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html#IdentificationMessage(java.lang.String)">IdentificationMessage</A></B>(java.lang.String userName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>IdentificationMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="IdentificationMessage(java.lang.String)"><!-- --></A><H3>
|
||||
IdentificationMessage</H3>
|
||||
<PRE>
|
||||
public <B>IdentificationMessage</B>(java.lang.String userName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>IdentificationMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="IdentificationMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,401 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
LemmingConnection
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.LemmingConnection class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="LemmingConnection";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="LemmingConnection.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class LemmingConnection</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.LemmingConnection</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>LemmingConnection</B><DT>extends java.lang.Object</DL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#LemmingConnection(java.net.Socket)">LemmingConnection</A></B>(java.net.Socket s)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>LemmingConnection</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#closeConnection()">closeConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Stops the LemmingsConnection</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#getClientQuit()">getClientQuit</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#getFullUpdateMessage()">getFullUpdateMessage</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#getUpdateMessage()">getUpdateMessage</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>getUpdateMessage</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#sendMessage(java.lang.String)">sendMessage</A></B>(java.lang.String msg)</CODE>
|
||||
|
||||
<BR>
|
||||
Sends the abstract message to the client,</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#setClientQuit(boolean)">setClientQuit</A></B>(boolean value)</CODE>
|
||||
|
||||
<BR>
|
||||
mutator</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#startListening()">startListening</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>startListening</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html#startSending()">startSending</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>startSending</code> method here.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="LemmingConnection(java.net.Socket)"><!-- --></A><H3>
|
||||
LemmingConnection</H3>
|
||||
<PRE>
|
||||
public <B>LemmingConnection</B>(java.net.Socket s)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>LemmingConnection</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>s</CODE> - a <code>Socket</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="startListening()"><!-- --></A><H3>
|
||||
startListening</H3>
|
||||
<PRE>
|
||||
public void <B>startListening</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>startListening</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="startSending()"><!-- --></A><H3>
|
||||
startSending</H3>
|
||||
<PRE>
|
||||
public void <B>startSending</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>startSending</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getClientQuit()"><!-- --></A><H3>
|
||||
getClientQuit</H3>
|
||||
<PRE>
|
||||
public boolean <B>getClientQuit</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>boolean</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setClientQuit(boolean)"><!-- --></A><H3>
|
||||
setClientQuit</H3>
|
||||
<PRE>
|
||||
public void <B>setClientQuit</B>(boolean value)</PRE>
|
||||
<DL>
|
||||
<DD>mutator
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>value</CODE> - v</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getUpdateMessage()"><!-- --></A><H3>
|
||||
getUpdateMessage</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>getUpdateMessage</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>getUpdateMessage</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractNetworkMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getFullUpdateMessage()"><!-- --></A><H3>
|
||||
getFullUpdateMessage</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>getFullUpdateMessage</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>abstract message</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="sendMessage(java.lang.String)"><!-- --></A><H3>
|
||||
sendMessage</H3>
|
||||
<PRE>
|
||||
public boolean <B>sendMessage</B>(java.lang.String msg)</PRE>
|
||||
<DL>
|
||||
<DD>Sends the abstract message to the client,
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - message
|
||||
<DT><B>Returns:</B><DD>success/fail</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="closeConnection()"><!-- --></A><H3>
|
||||
closeConnection</H3>
|
||||
<PRE>
|
||||
public void <B>closeConnection</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Stops the LemmingsConnection
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="LemmingConnection.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,440 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
LemmingNetworking
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.LemmingNetworking class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="LemmingNetworking";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="LemmingNetworking.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class LemmingNetworking</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.LemmingNetworking</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public final class <B>LemmingNetworking</B><DT>extends java.lang.Object</DL>
|
||||
|
||||
<P>
|
||||
The <code>LemmingNetworking</code> class is the facade to the
|
||||
entire package.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>1.0</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><a href="mailto:gtg563g@gatech.edu">Daniyar Zhanbekov</a></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#LemmingNetworking()">LemmingNetworking</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#acceptConnection(java.net.Socket)">acceptConnection</A></B>(java.net.Socket client)</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>getConnection</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#connectTo(java.lang.String, int)">connectTo</A></B>(java.lang.String host,
|
||||
int port)</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>connectTo</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking">LemmingConnection</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#getConnection()">getConnection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>getConnection</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking">LemmingNetworking</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#getInstance()">getInstance</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Singleton implementation.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#isConnected()">isConnected</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>isConnected</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#listenForConnection(int)">listenForConnection</A></B>(int port)</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>listenForConnection</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#receiveMessage(java.lang.String)">receiveMessage</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>receiveMessage</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#sendMessage(edu.gatech.cs2335.lemmings.networking.AbstractMessage)">sendMessage</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> message)</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>sendMessage</code> method here.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html#shutDownNetworking()">shutDownNetworking</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Describe <code>shutDownNetworking</code> method here.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="LemmingNetworking()"><!-- --></A><H3>
|
||||
LemmingNetworking</H3>
|
||||
<PRE>
|
||||
public <B>LemmingNetworking</B>()</PRE>
|
||||
<DL>
|
||||
</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="getInstance()"><!-- --></A><H3>
|
||||
getInstance</H3>
|
||||
<PRE>
|
||||
public static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking">LemmingNetworking</A> <B>getInstance</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Singleton implementation.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an <code>LemmingNetworking</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="listenForConnection(int)"><!-- --></A><H3>
|
||||
listenForConnection</H3>
|
||||
<PRE>
|
||||
public boolean <B>listenForConnection</B>(int port)</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>listenForConnection</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>port</CODE> - an <code>int</code> value
|
||||
<DT><B>Returns:</B><DD>boolean</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="connectTo(java.lang.String, int)"><!-- --></A><H3>
|
||||
connectTo</H3>
|
||||
<PRE>
|
||||
public boolean <B>connectTo</B>(java.lang.String host,
|
||||
int port)</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>connectTo</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>host</CODE> - a <code>String</code> value<DD><CODE>port</CODE> - an <code>int</code> value
|
||||
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="shutDownNetworking()"><!-- --></A><H3>
|
||||
shutDownNetworking</H3>
|
||||
<PRE>
|
||||
public boolean <B>shutDownNetworking</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>shutDownNetworking</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="isConnected()"><!-- --></A><H3>
|
||||
isConnected</H3>
|
||||
<PRE>
|
||||
public boolean <B>isConnected</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>isConnected</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="sendMessage(edu.gatech.cs2335.lemmings.networking.AbstractMessage)"><!-- --></A><H3>
|
||||
sendMessage</H3>
|
||||
<PRE>
|
||||
public boolean <B>sendMessage</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> message)</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>sendMessage</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - an <code>AbstractMessage</code> value
|
||||
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="receiveMessage(java.lang.String)"><!-- --></A><H3>
|
||||
receiveMessage</H3>
|
||||
<PRE>
|
||||
protected void <B>receiveMessage</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>receiveMessage</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getConnection()"><!-- --></A><H3>
|
||||
getConnection</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking">LemmingConnection</A> <B>getConnection</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>getConnection</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>LemmingConnection</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="acceptConnection(java.net.Socket)"><!-- --></A><H3>
|
||||
acceptConnection</H3>
|
||||
<PRE>
|
||||
protected void <B>acceptConnection</B>(java.net.Socket client)</PRE>
|
||||
<DL>
|
||||
<DD>Describe <code>getConnection</code> method here.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>client</CODE> - a <code>LemmingConnection</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="LemmingNetworking.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,316 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
LevelFinishMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.LevelFinishMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="LevelFinishMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="LevelFinishMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class LevelFinishMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.LevelFinishMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>LevelFinishMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html#LevelFinishMessage(java.lang.String)">LevelFinishMessage</A></B>(java.lang.String userName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>IdentificationMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="LevelFinishMessage(java.lang.String)"><!-- --></A><H3>
|
||||
LevelFinishMessage</H3>
|
||||
<PRE>
|
||||
public <B>LevelFinishMessage</B>(java.lang.String userName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>IdentificationMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="LevelFinishMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,313 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
MessageFactory
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.MessageFactory class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageFactory";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageFactory.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class MessageFactory</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.MessageFactory</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public final class <B>MessageFactory</B><DT>extends java.lang.Object</DL>
|
||||
|
||||
<P>
|
||||
Class MessageFactory: Creates messages.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (Apr. 8, 2004) - Created the MessageFactory class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0, Jan. 26, 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg563g@mail.gatech.edu">Daniyar Zhanbekov</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html#createMessage(java.lang.String, java.util.List)">createMessage</A></B>(java.lang.String messageType,
|
||||
java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a network message class from a list of data.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking">MessageFactory</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html#getInstance()">getInstance</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Singleton implementation.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html#makeBlankMessage(java.lang.String, java.lang.String)">makeBlankMessage</A></B>(java.lang.String messageType,
|
||||
java.lang.String authorName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a message of the specified type with the default
|
||||
parameters.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html#parseMessage(java.lang.String)">parseMessage</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string passed in and returns the appropriate network message.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="getInstance()"><!-- --></A><H3>
|
||||
getInstance</H3>
|
||||
<PRE>
|
||||
public static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking">MessageFactory</A> <B>getInstance</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Singleton implementation.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>MessageFactory</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parseMessage(java.lang.String)"><!-- --></A><H3>
|
||||
parseMessage</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parseMessage</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string passed in and returns the appropriate network message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="createMessage(java.lang.String, java.util.List)"><!-- --></A><H3>
|
||||
createMessage</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>createMessage</B>(java.lang.String messageType,
|
||||
java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a network message class from a list of data.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>messageType</CODE> - a <code>String</code> value<DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="makeBlankMessage(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
makeBlankMessage</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>makeBlankMessage</B>(java.lang.String messageType,
|
||||
java.lang.String authorName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a message of the specified type with the default
|
||||
parameters. The message returned is basically considered empty.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>messageType</CODE> - a <code>String</code> value<DD><CODE>authorName</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageFactory.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,424 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
MessageSettings
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.MessageSettings class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="MessageSettings";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageSettings.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class MessageSettings</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.MessageSettings</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public final class <B>MessageSettings</B><DT>extends java.lang.Object</DL>
|
||||
|
||||
<P>
|
||||
Class MessageSettings: This class contains the settings shared
|
||||
|
||||
among all the different messages, as well as the MessageFactory.
|
||||
|
||||
|
||||
|
||||
<PRE>
|
||||
|
||||
Revision History:
|
||||
|
||||
v1.0 (Apr 8, 2004) - Created the MessageSettings class
|
||||
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0, Apr 8, 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg563g@mail.gatech.edu">Daniyar Zhanbekov</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_FLOW">TYPE_FLOW</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all flow messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_HELO">TYPE_HELO</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all helo(join) messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_LENGTH">TYPE_LENGTH</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
The length of the message type string.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_LEVELEND">TYPE_LEVELEND</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_NUKE">TYPE_NUKE</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all nuke request messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_PAUSE">TYPE_PAUSE</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all pause messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_SPEED">TYPE_SPEED</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all change speed messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_STAT">TYPE_STAT</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with stats update messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_UNKNOWN">TYPE_UNKNOWN</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all unknown messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html#TYPE_UPDATE">TYPE_UPDATE</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Message type associated with all update messages.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Field Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="TYPE_UNKNOWN"><!-- --></A><H3>
|
||||
TYPE_UNKNOWN</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_UNKNOWN</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all unknown messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_UNKNOWN">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_STAT"><!-- --></A><H3>
|
||||
TYPE_STAT</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_STAT</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with stats update messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_STAT">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_PAUSE"><!-- --></A><H3>
|
||||
TYPE_PAUSE</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_PAUSE</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all pause messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_PAUSE">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_UPDATE"><!-- --></A><H3>
|
||||
TYPE_UPDATE</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_UPDATE</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all update messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_UPDATE">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_SPEED"><!-- --></A><H3>
|
||||
TYPE_SPEED</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_SPEED</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all change speed messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_SPEED">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_NUKE"><!-- --></A><H3>
|
||||
TYPE_NUKE</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_NUKE</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all nuke request messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_NUKE">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_FLOW"><!-- --></A><H3>
|
||||
TYPE_FLOW</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_FLOW</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all flow messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_FLOW">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_HELO"><!-- --></A><H3>
|
||||
TYPE_HELO</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_HELO</B></PRE>
|
||||
<DL>
|
||||
<DD>Message type associated with all helo(join) messages.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_HELO">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_LEVELEND"><!-- --></A><H3>
|
||||
TYPE_LEVELEND</H3>
|
||||
<PRE>
|
||||
public static final java.lang.String <B>TYPE_LEVELEND</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_LEVELEND">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TYPE_LENGTH"><!-- --></A><H3>
|
||||
TYPE_LENGTH</H3>
|
||||
<PRE>
|
||||
public static final int <B>TYPE_LENGTH</B></PRE>
|
||||
<DL>
|
||||
<DD>The length of the message type string.
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#edu.gatech.cs2335.lemmings.networking.MessageSettings.TYPE_LENGTH">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="MessageSettings.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,330 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
NukeRequestMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.NukeRequestMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="NukeRequestMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="NukeRequestMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class NukeRequestMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.NukeRequestMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>NukeRequestMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class NukeRequestMessage: Sent by host or client when Nuke is
|
||||
desired.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (April 08, 2004) - Created the NukeRequestMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0,April 08 , 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg284h@mail.gatech.edu">Andrew Knight</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html#NukeRequestMessage(java.lang.String)">NukeRequestMessage</A></B>(java.lang.String userName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>NukeRequestMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="NukeRequestMessage(java.lang.String)"><!-- --></A><H3>
|
||||
NukeRequestMessage</H3>
|
||||
<PRE>
|
||||
public <B>NukeRequestMessage</B>(java.lang.String userName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>NukeRequestMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="NukeRequestMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,372 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
PauseMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.PauseMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="PauseMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="PauseMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class PauseMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.PauseMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>PauseMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class PauseMessage: Sent by host or client when game is paused.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (April 08, 2004) - Created the PauseMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0,April 08 , 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg284h@mail.gatech.edu">Andrew Knight</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html#PauseMessage(java.lang.String)">PauseMessage</A></B>(java.lang.String userName)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>PauseMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html#getPause()">getPause</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Accessor for pause boolean</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html#setPause(boolean)">setPause</A></B>(boolean p)</CODE>
|
||||
|
||||
<BR>
|
||||
Modifier for pause boolean</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="PauseMessage(java.lang.String)"><!-- --></A><H3>
|
||||
PauseMessage</H3>
|
||||
<PRE>
|
||||
public <B>PauseMessage</B>(java.lang.String userName)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>PauseMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPause()"><!-- --></A><H3>
|
||||
getPause</H3>
|
||||
<PRE>
|
||||
public boolean <B>getPause</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Accessor for pause boolean
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>boolean , paused or not</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setPause(boolean)"><!-- --></A><H3>
|
||||
setPause</H3>
|
||||
<PRE>
|
||||
public void <B>setPause</B>(boolean p)</PRE>
|
||||
<DL>
|
||||
<DD>Modifier for pause boolean
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>p</CODE> - , paused or not</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="PauseMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,484 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
StatsMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.StatsMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="StatsMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="StatsMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class StatsMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.StatsMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>StatsMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class StatsMessage: Represents the update lemming message.
|
||||
|
||||
|
||||
Format:
|
||||
STAT^author^lemmings_released^lemmings_saved^lemmings_dead^lemmings_total
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (Apr 8, 2004) - Created the StatsMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0, Jan. 29, 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg563g@prism.gatech.edu">Daniyar Zhanbekov</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#StatsMessage(java.lang.String)">StatsMessage</A></B>(java.lang.String author)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>StatsMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#getLemmingsDead()">getLemmingsDead</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Access method for the lemmingsDead property.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#getLemmingsReleased()">getLemmingsReleased</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Access method for the lemmingsReleased property.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#getLemmingsSaved()">getLemmingsSaved</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Get the lemmings saved</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#getLemmingsTotal()">getLemmingsTotal</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Access method for the lemmingsTotal property.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#setLemmingsDead(int)">setLemmingsDead</A></B>(int aLemmingsDead)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the value of the lemmingsDead property.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#setLemmingsReleased(int)">setLemmingsReleased</A></B>(int aLemmingsReleased)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the value of the lemmingsReleased property.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#setLemmingsTotal(int)">setLemmingsTotal</A></B>(int aLemmingsTotal)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the value of the lemmingsTotal property.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="StatsMessage(java.lang.String)"><!-- --></A><H3>
|
||||
StatsMessage</H3>
|
||||
<PRE>
|
||||
public <B>StatsMessage</B>(java.lang.String author)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>StatsMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>author</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="getLemmingsSaved()"><!-- --></A><H3>
|
||||
getLemmingsSaved</H3>
|
||||
<PRE>
|
||||
public final int <B>getLemmingsSaved</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Get the lemmings saved
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>lemmingsSaved.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLemmingsDead()"><!-- --></A><H3>
|
||||
getLemmingsDead</H3>
|
||||
<PRE>
|
||||
public int <B>getLemmingsDead</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Access method for the lemmingsDead property.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the current value of the lemmingsDead property</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLemmingsDead(int)"><!-- --></A><H3>
|
||||
setLemmingsDead</H3>
|
||||
<PRE>
|
||||
public void <B>setLemmingsDead</B>(int aLemmingsDead)</PRE>
|
||||
<DL>
|
||||
<DD>Sets the value of the lemmingsDead property.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>aLemmingsDead</CODE> - the new value of the lemmingsDead property</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLemmingsReleased()"><!-- --></A><H3>
|
||||
getLemmingsReleased</H3>
|
||||
<PRE>
|
||||
public int <B>getLemmingsReleased</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Access method for the lemmingsReleased property.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the current value of the lemmingsReleased property</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLemmingsReleased(int)"><!-- --></A><H3>
|
||||
setLemmingsReleased</H3>
|
||||
<PRE>
|
||||
public void <B>setLemmingsReleased</B>(int aLemmingsReleased)</PRE>
|
||||
<DL>
|
||||
<DD>Sets the value of the lemmingsReleased property.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>aLemmingsReleased</CODE> - the new value of the lemmingsReleased property</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLemmingsTotal()"><!-- --></A><H3>
|
||||
getLemmingsTotal</H3>
|
||||
<PRE>
|
||||
public int <B>getLemmingsTotal</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Access method for the lemmingsTotal property.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the current value of the lemmingsTotal property</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLemmingsTotal(int)"><!-- --></A><H3>
|
||||
setLemmingsTotal</H3>
|
||||
<PRE>
|
||||
public void <B>setLemmingsTotal</B>(int aLemmingsTotal)</PRE>
|
||||
<DL>
|
||||
<DD>Sets the value of the lemmingsTotal property.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>aLemmingsTotal</CODE> - the new value of the lemmingsTotal property</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network. The format is as follows:
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="StatsMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,506 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
UpdateMessage
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking.UpdateMessage class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="UpdateMessage";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="UpdateMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.networking</FONT>
|
||||
<BR>
|
||||
Class UpdateMessage</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">edu.gatech.cs2335.lemmings.networking.AbstractMessage</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.networking.UpdateMessage</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public class <B>UpdateMessage</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></DL>
|
||||
|
||||
<P>
|
||||
Class UpdateMessage: Represents the update lemming message.
|
||||
|
||||
|
||||
Format:
|
||||
UPDT^x^y^lemmings_saved^lemmings_out^job_id^x^y^z^i^j^k^
|
||||
num_updates^type^shape^x^y^width^height...
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (Apr 8, 2004) - Created the UpdateMessage class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0, Jan. 29, 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg563g@prism.gatech.edu">Daniyar Zhanbekov</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#UpdateMessage(java.lang.String)">UpdateMessage</A></B>(java.lang.String author)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>UpdateMessage</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#addLemming(edu.gatech.cs2335.lemmings.engine.Lemming)">addLemming</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> l)</CODE>
|
||||
|
||||
<BR>
|
||||
Add a Lemming to the lemmings List.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#addTerrainUpdate(java.awt.Shape)">addTerrainUpdate</A></B>(java.awt.Shape s)</CODE>
|
||||
|
||||
<BR>
|
||||
Add a terrain to the terrain List.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#buildMessage(java.util.List)">buildMessage</A></B>(java.util.List data)</CODE>
|
||||
|
||||
<BR>
|
||||
Builds a message from the data provided.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.util.List</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#getLemmings()">getLemmings</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Get the lemmings</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#getLemmingsSaved()">getLemmingsSaved</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Get the lemmings saved</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.util.List</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#getTerrainUpdates()">getTerrainUpdates</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Get the terrain Updates</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/Point.html" title="class in edu.gatech.cs2335.lemmings.physics">Point</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#getViewPoint()">getViewPoint</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Get the viewPoint</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#parse(java.lang.String)">parse</A></B>(java.lang.String message)</CODE>
|
||||
|
||||
<BR>
|
||||
Parses the string into the specific message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#setTerrainUpdates(java.util.List)">setTerrainUpdates</A></B>(java.util.List v)</CODE>
|
||||
|
||||
<BR>
|
||||
Set the terrain Updates</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#setViewPoint(edu.gatech.cs2335.lemmings.physics.Point)">setViewPoint</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/Point.html" title="class in edu.gatech.cs2335.lemmings.physics">Point</A> v)</CODE>
|
||||
|
||||
<BR>
|
||||
set the viewPoint</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html#tokenize()">tokenize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a string representation of the message fit for plain-text
|
||||
transmission over the network.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.networking.AbstractMessage"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getAuthor()">getAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType()">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#getMessageType(java.lang.String)">getMessageType</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setAuthor(java.lang.String)">setAuthor</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#setMessageType(java.lang.String)">setMessageType</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="UpdateMessage(java.lang.String)"><!-- --></A><H3>
|
||||
UpdateMessage</H3>
|
||||
<PRE>
|
||||
public <B>UpdateMessage</B>(java.lang.String author)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>UpdateMessage</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>author</CODE> - a <code>String</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="getLemmingsSaved()"><!-- --></A><H3>
|
||||
getLemmingsSaved</H3>
|
||||
<PRE>
|
||||
public final int <B>getLemmingsSaved</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Get the lemmings saved
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>lemmingsSaved.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getViewPoint()"><!-- --></A><H3>
|
||||
getViewPoint</H3>
|
||||
<PRE>
|
||||
public final <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/Point.html" title="class in edu.gatech.cs2335.lemmings.physics">Point</A> <B>getViewPoint</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Get the viewPoint
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>viewPoint.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setViewPoint(edu.gatech.cs2335.lemmings.physics.Point)"><!-- --></A><H3>
|
||||
setViewPoint</H3>
|
||||
<PRE>
|
||||
public final void <B>setViewPoint</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/Point.html" title="class in edu.gatech.cs2335.lemmings.physics">Point</A> v)</PRE>
|
||||
<DL>
|
||||
<DD>set the viewPoint
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>v</CODE> - value to set.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLemmings()"><!-- --></A><H3>
|
||||
getLemmings</H3>
|
||||
<PRE>
|
||||
public final java.util.List <B>getLemmings</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Get the lemmings
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>lemmings.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getTerrainUpdates()"><!-- --></A><H3>
|
||||
getTerrainUpdates</H3>
|
||||
<PRE>
|
||||
public final java.util.List <B>getTerrainUpdates</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Get the terrain Updates
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>terrain updats.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setTerrainUpdates(java.util.List)"><!-- --></A><H3>
|
||||
setTerrainUpdates</H3>
|
||||
<PRE>
|
||||
public final void <B>setTerrainUpdates</B>(java.util.List v)</PRE>
|
||||
<DL>
|
||||
<DD>Set the terrain Updates
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>v</CODE> - value for terrain updats.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="addLemming(edu.gatech.cs2335.lemmings.engine.Lemming)"><!-- --></A><H3>
|
||||
addLemming</H3>
|
||||
<PRE>
|
||||
public final void <B>addLemming</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> l)</PRE>
|
||||
<DL>
|
||||
<DD>Add a Lemming to the lemmings List.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>l</CODE> - value to add</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="addTerrainUpdate(java.awt.Shape)"><!-- --></A><H3>
|
||||
addTerrainUpdate</H3>
|
||||
<PRE>
|
||||
public final void <B>addTerrainUpdate</B>(java.awt.Shape s)</PRE>
|
||||
<DL>
|
||||
<DD>Add a terrain to the terrain List.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>s</CODE> - value to add</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="tokenize()"><!-- --></A><H3>
|
||||
tokenize</H3>
|
||||
<PRE>
|
||||
public final java.lang.String <B>tokenize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a string representation of the message fit for plain-text
|
||||
transmission over the network. The format is as follows:
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html#tokenize()">tokenize</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>String</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="parse(java.lang.String)"><!-- --></A><H3>
|
||||
parse</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>parse</B>(java.lang.String message)</PRE>
|
||||
<DL>
|
||||
<DD>Parses the string into the specific message.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>message</CODE> - a <code>String</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="buildMessage(java.util.List)"><!-- --></A><H3>
|
||||
buildMessage</H3>
|
||||
<PRE>
|
||||
protected static <A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> <B>buildMessage</B>(java.util.List data)</PRE>
|
||||
<DL>
|
||||
<DD>Builds a message from the data provided.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>data</CODE> - a <code>List</code> value
|
||||
<DT><B>Returns:</B><DD>an <code>AbstractMessage</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="UpdateMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,58 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:22 EDT 2004 -->
|
||||
<TITLE>
|
||||
edu.gatech.cs2335.lemmings.networking
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking package">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white">
|
||||
<FONT size="+1" CLASS="FrameTitleFont">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/package-summary.html" target="classFrame">edu.gatech.cs2335.lemmings.networking</A></FONT>
|
||||
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
|
||||
<TR>
|
||||
<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont">
|
||||
Classes</FONT>
|
||||
<FONT CLASS="FrameItemFont">
|
||||
<BR>
|
||||
<A HREF="AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">AbstractMessage</A>
|
||||
<BR>
|
||||
<A HREF="ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">ChangeLemmingFlowMessage</A>
|
||||
<BR>
|
||||
<A HREF="ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">ChangeSpeedMessage</A>
|
||||
<BR>
|
||||
<A HREF="ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">ConnectionListener</A>
|
||||
<BR>
|
||||
<A HREF="IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">IdentificationMessage</A>
|
||||
<BR>
|
||||
<A HREF="LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">LemmingConnection</A>
|
||||
<BR>
|
||||
<A HREF="LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">LemmingNetworking</A>
|
||||
<BR>
|
||||
<A HREF="LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">LevelFinishMessage</A>
|
||||
<BR>
|
||||
<A HREF="MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">MessageFactory</A>
|
||||
<BR>
|
||||
<A HREF="MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">MessageSettings</A>
|
||||
<BR>
|
||||
<A HREF="NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">NukeRequestMessage</A>
|
||||
<BR>
|
||||
<A HREF="PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">PauseMessage</A>
|
||||
<BR>
|
||||
<A HREF="StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">StatsMessage</A>
|
||||
<BR>
|
||||
<A HREF="UpdateMessage.html" title="class in edu.gatech.cs2335.lemmings.networking" target="classFrame">UpdateMessage</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,203 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:22 EDT 2004 -->
|
||||
<TITLE>
|
||||
edu.gatech.cs2335.lemmings.networking
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.networking package">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="edu.gatech.cs2335.lemmings.networking";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/package-summary.html"><B>PREV PACKAGE</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<H2>
|
||||
Package edu.gatech.cs2335.lemmings.networking
|
||||
</H2>
|
||||
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Class Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A></B></TD>
|
||||
<TD>Class AbstractMessage: This class is the base for all network
|
||||
messages that will be sent between the client and the server.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">ChangeLemmingFlowMessage</A></B></TD>
|
||||
<TD>Class ChangeLemmingFlowMessage: Sent to change lemming flow.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">ChangeSpeedMessage</A></B></TD>
|
||||
<TD>Class ChangeSpeedMessage: Sent to change speed of game.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking">ConnectionListener</A></B></TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">IdentificationMessage</A></B></TD>
|
||||
<TD>Class IdentificationMessage: Sends username to other player.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking">LemmingConnection</A></B></TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking">LemmingNetworking</A></B></TD>
|
||||
<TD>The <code>LemmingNetworking</code> class is the facade to the
|
||||
entire package.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">LevelFinishMessage</A></B></TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking">MessageFactory</A></B></TD>
|
||||
<TD>Class MessageFactory: Creates messages.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking">MessageSettings</A></B></TD>
|
||||
<TD>Class MessageSettings: This class contains the settings shared
|
||||
|
||||
among all the different messages, as well as the MessageFactory.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">NukeRequestMessage</A></B></TD>
|
||||
<TD>Class NukeRequestMessage: Sent by host or client when Nuke is
|
||||
desired.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">PauseMessage</A></B></TD>
|
||||
<TD>Class PauseMessage: Sent by host or client when game is paused.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">StatsMessage</A></B></TD>
|
||||
<TD>Class StatsMessage: Represents the update lemming message.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">UpdateMessage</A></B></TD>
|
||||
<TD>Class UpdateMessage: Represents the update lemming message.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/package-summary.html"><B>PREV PACKAGE</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,146 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:22 EDT 2004 -->
|
||||
<TITLE>
|
||||
edu.gatech.cs2335.lemmings.networking Class Hierarchy
|
||||
</TITLE>
|
||||
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="edu.gatech.cs2335.lemmings.networking Class Hierarchy";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/package-tree.html"><B>PREV</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/package-tree.html"><B>NEXT</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<CENTER>
|
||||
<H2>
|
||||
Hierarchy For Package edu.gatech.cs2335.lemmings.networking
|
||||
</H2>
|
||||
</CENTER>
|
||||
<DL>
|
||||
<DT><B>Package Hierarchies:</B><DD><A HREF="../../../../../overview-tree.html">All Packages</A></DL>
|
||||
<HR>
|
||||
<H2>
|
||||
Class Hierarchy
|
||||
</H2>
|
||||
<UL>
|
||||
<LI TYPE="circle">class java.lang.Object<UL>
|
||||
<LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>AbstractMessage</B></A><UL>
|
||||
<LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeLemmingFlowMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>ChangeLemmingFlowMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ChangeSpeedMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>ChangeSpeedMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/IdentificationMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>IdentificationMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LevelFinishMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>LevelFinishMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/NukeRequestMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>NukeRequestMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/PauseMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>PauseMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/StatsMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>StatsMessage</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/UpdateMessage.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>UpdateMessage</B></A></UL>
|
||||
<LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/ConnectionListener.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>ConnectionListener</B></A> (implements java.lang.Runnable)
|
||||
<LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingConnection.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>LemmingConnection</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/LemmingNetworking.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>LemmingNetworking</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageFactory.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>MessageFactory</B></A><LI TYPE="circle">class edu.gatech.cs2335.lemmings.networking.<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/MessageSettings.html" title="class in edu.gatech.cs2335.lemmings.networking"><B>MessageSettings</B></A></UL>
|
||||
</UL>
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/package-tree.html"><B>PREV</B></A>
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/package-tree.html"><B>NEXT</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user