FreePastry/license/Sample.java

/*************************************************************************

"FreePastry" Peer-to-Peer Application Development Substrate 

Copyright 2002, Rice University. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

- Neither  the name  of Rice  University (RICE) nor  the names  of its
contributors may be  used to endorse or promote  products derived from
this software without specific prior written permission.

This software is provided by RICE and the contributors on an "as is"
basis, without any representations or warranties of any kind, express
or implied including, but not limited to, representations or
warranties of non-infringement, merchantability or fitness for a
particular purpose. In no event shall RICE or contributors be liable
for any direct, indirect, incidental, special, exemplary, or
consequential damages (including, but not limited to, procurement of
substitute goods or services; loss of use, data, or profits; or
business interruption) however caused and on any theory of liability,
whether in contract, strict liability, or tort (including negligence
or otherwise) arising in any way out of the use of this software, even
if advised of the possibility of such damage.

********************************************************************************/


/**
 * A short class for demonstrating the standard header for our files
 * and the documentation standard we will use. 
 *
 * @author Andrew Ladd
 */

public class Sample {
  /**
   * This integer is pointless.
   */
  public int nothing;

  // private stuff is ignored in the docs - internal docs only.
  private int something;

  /**
   * Constructor.
   *
   * @param s a value for some reason.
   */

  public Sample(int s) {
    something = s;
    nothing = 2 * s;
  }
  
  /**
   * Eats a number and returns a product.
   *
   * In the long summary we can be more clear.
   *
   * @param x the number to eat.
   * @return a product.
   */
  
  public int eat(int x) {
    return nothing * something * x;
  }
}