scribbledecobble: Nine Inch Nails

README

Code

/**
 * The <code>Nails</code> class is a driver that tests
 * the <code>Nail</code> and <code>NineInchNails</code>
 * classes by calling the <code>main</code> methods of
 * the classes under test when the <code>main</code>
 * method of the <code>Nails</code> class executes.
 *
 * @author: Spurgeon (John)
 * @version: 1.0
 */
public class Nails {
  public static void main(String[] args) {
    Nail.main(args);
    System.out.println();
    NineInchNails.main(args);
  }
}

/**
 * The <code>NineInchNails</code> class provides a method
 * that prints nine one-inch nails and a method that
 * prints <i>n</i> nine-inch nails. The methods print a
 * ruler above the nails.
 *
 * @author: Spurgeon (John)
 * @version: 1.0
 */
class NineInchNails {
  public static void print() {
    String oneInchNail = Nail.makeOneInch();
    System.out.println(Ruler.make(1));
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
    System.out.println(oneInchNail);
  }
  public static void print(int n) {
    String nineInchNail = Nail.makeNineInch();
    System.out.println(Ruler.make(9));
    while (n > 0) {
      System.out.println(nineInchNail);
      n = n - 1;
    }
  }
  public static void main(String[] args) {    
    System.out.println("TESTING NineInchNails");
    System.out.println("\nNine One-Inch Nails\n");
    NineInchNails.print();
    System.out.println("\nTwo Nine-Inch Nails\n");
    NineInchNails.print(2);
  }
}

/**
 * The <code>Ruler</code> class provides a method
 * that makes an <i>n</i>-inch ruler.
 *
 * @author: Spurgeon (John)
 * @version: 1.0
 */
class Ruler {
  /**
   * Returns an <i>n</i>-inch ruler with graduation
   * markings spaced 1/8th inch apart. The ruler is
   * merely a model of a ruler; it is not to scale.
   *
   * @param n The number of inches the ruler is long.
   * @author: Spurgeon (John)
   * @version: 1.0
   */
  public static String make(int n) {
    final String graduations = "...:...";
    String ruler = "";
    while (n > 0) {
      ruler = graduations + n + ruler;
      n = n - 1;
    }
    ruler = n + ruler;
    return ruler;
  }  
}

/**
 * The <code>Nail</code> class provides methods that
 * that make standard one- and nine-inch nails and
 * a method that makes custom-sized nails.
 *
 * @author: Spurgeon (John)
 * @version: 1.0
 */
class Nail {
  public static String makeOneInch() {
    final String nail = "|======>";
    return nail;
  }
  public static String makeNineInch() {
    String nail = "|=======";
    nail = nail + "========";
    nail = nail + "========";
    nail = nail + "========";
    nail = nail + "========";
    nail = nail + "========";
    nail = nail + "========";
    nail = nail + "========";
    nail = nail + "=======>";
    return nail;
  }
  public static String make(double inches) {
    if (inches <= 0) {
      return "";
    }
    else if (inches <= 1.0/8.0) {
      return ">";
    }
    else if (inches <= 1.0/4.0) {
      return "|>";
    }
    else {
      return "Not implemented yet.";
    }
  }
  public static void main(String[] args) {

    String ruler1, ruler2, ruler9;
    Double nailSize;
    
    ruler1 = Ruler.make(1);
    ruler2 = Ruler.make(2);
    ruler9 = Ruler.make(9);
    
    System.out.println("TESTING Nail");

    System.out.println("\nStandard Nails\n");
    
    System.out.println("Standard 1 inch nail:");
    System.out.println(ruler1);
    System.out.println(Nail.makeOneInch());
    
    System.out.println("\nStandard 9 inch nail:");
    System.out.println(ruler9);
    System.out.println(Nail.makeNineInch());
    
    System.out.println("\nCustom Nails");
    
    nailSize = -1.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 0.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.0/16.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.0/8.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.0/4.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 3.0/8.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.0/2.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.0;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.1;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
    
    nailSize = 1.5;
    System.out.println("\nCustom " + nailSize + " inch nail:");
    System.out.println(ruler2);
    System.out.println(Nail.make(nailSize));
  }
}

Q&A

Notes

Exercises

Carefully study the “Nine Inch Nails” code shown on the Code tab of this MESS.
1. As you study the code, refer to sections 1.2 and 1.3 of Computer Science - An Interdisciplinary Approach by Sedgewick and Wayne. Almost everything you need to know to understand the code is covered in those sections of that book.
2. Ask questions if you encounter code you don’t understand.
3. Compile the code.
4. Try each of the following ways of executing the code after you have successfully compiled it. Make sure you understand what you are doing and observing.
  1. java Nails
  2. java NineInchNails
  3. java Nail
Add a main method to the Ruler class.
1. Your main method should be analogous to the main method of the Nail class. When the new main method executes it should exercise (i.e. test) the Ruler.make method.
2. Execute your main method using the command java Ruler.
Call your Ruler.main method (exercise 2) from the Nails.main method.
1. Call Ruler.main before Nail.main is called.
2. Update the Javadoc comment for the Nails class. Update the description, add your name to the list of authors, and change the version number.
In the method NineInchNails.print, replace the nine identical System.out.println statements with a loop that executes the statement nine times.
In the method Nail.makeNineInch, replace the seven identical assignment statements with a loop that accomplishes the same thing.
Simplify the Nail.main method as follows.
1. Add a method called testMake to the class Nail. Define testMake in terms of a parameter of type double.
2. The Nail.main method repeatedly calls the same sequence of three System.out.println statements several times. Replace each of these repeated series of statements with a call to Nail.testMake that does the same thing.
Finish implementing the method Nail.make.
Document the Nail.make method using a Javadoc style comment. After you have added your comment, use the javadoc.exe utility to produce .html files using a file named Nails.java as input. Open the file named index.html in a web browser and study what you see.

scribbledecobble

Pages

Nine Inch Nails

README

See Also

Code

Q&A

Notes

Exercises