/**
This is a class for a toy that might be
in a simulation similar to the phone system.
This shows the use of some simple html tagging.
Of course the basics of javadoc have been given
you in the 
<a href="http://www.ccs.neu.edu/home/futrelle/teaching/com1204sp2001/demo1/index.html">Demo1 pages</a>.

<p>
@author R. P. Futrelle
@version 1.0  5/24/01
</p>
<p>
The all-important step() function calls on
the following modules:
</p>
<ul>
  <li>moveMe() that moves the toy according to its
current direction and speed.
  </li>
  <li>speak() which may cause the toy to "say" something.
Calls the insert() method of the "air" to insert the speech "sound".
  </li>
  <li>wiggle() which causes it to move its arms about wildly.
  </li>
  <li>grimace() that causes it to make funny facial expressions.
  </li>
  <li>push() applied to some object in its vicinity.
  current direction and speed.
  </li>
  <li>carry() to carry an object that has been picked up.
  </li>
  <li>pickup() applies to small objects within reach.
  </li>
  <li>putdown() puts down whatever it's holding.
  </li>
</ul>
<p>
The major set of actions performed on the toy,
its public methods, are the following:
</p>
<ul>
<li>set() to alter its settings, such as direction and speed.
</li>
<li>windup() to give it the energy to operate.
</li>
<li>turnOnOff() to run or stop the toy.
</li>
<li>move() to move it to another location.
</li>
</ul>
**/

public class Toy {

    boolean toMove;
    boolean toSpeak;
    boolean toWiggle;
    boolean toGrimace;
    boolean toPush;
    boolean toCarry;
    boolean toPickup;
    boolean toPutDown;

/**
<p>
This calls the following modules:
</p>
<ul>
  <li>moveMe() that moves the toy according to its
current direction and speed.
  </li>
  <li>speak() which may cause the toy to "say" something.
Calls the insert() method of the "air" to insert the speech "sound". 
  </li>
  <li>wiggle() which causes it to move its arms about wildly.
  </li>
  <li>grimace() that causes it to make funny facial expressions.
  </li>
  <li>push() applied to some object in its vicinity.
  current direction and speed.
  </li>
  <li>carry() to carry what the toy has picked up.
  </li>
  <li>pickup() applies to small objects within reach.
  </li>
  <li>putdown() puts down whatever it's holding.
  </li>
</ul>
<p>
(The above repeats material in the class comments, but
that may be helpful -- may not.)
</p>
<p>
In this imaginary example, I assume that actions are controlled
by flags which are in turn set by the various methods called
by step() and by calls to the public methods of the class.
You can clearly see that this makes step() very simple.
If any of your methods start to become complex and have too
many different tasks being done, all in the same method,
it is best to divide up those tasks into calls to other
(private) methods that you define.  An example in step()
below that uses an if-else construction shows this.
</p>
     **/
    public void step() {

    if(toMove)
	moveMe();
    if(toSpeak)
	speak();
    if(toWiggle)
	wiggle();
    if(toGrimace)
	grimace();
    if(toPush)
	push();

    if(toCarry)
	carry();
    else {
	if(toPickup)
	    pickup();
	if(toPutDown)
	    putDown();
    }
    }

    /**
     * Allows a user to wind up the toy to give
     * it energy for its actions. 
     * (Note the use of param and return tags,
     * but only at the end of the javadoc comments for
     * the method.)
     * @param howMuch A value between 0.0 and 100.0
     * which is what fraction of its total windup you
     * wish to add -- values outside  this range are
     * truncated to this range. 
     * @return The amount of windup the toy now has
     * after this latest windup -- never greater than 100.0.
     **/
    public double windup(double howMuch) {
	return 0.0;
    }

    public void set(){}
    public void turnOnOff(){}
    public void move(){}

    private void moveMe(){}
    private void speak(){}
    private void wiggle(){}
    private void grimace(){}
    private void push(){}
    private void carry(){}
    private void pickup(){}
    private void putDown(){}
}