• How do you write a simple method?
  
• What is the difference between a local and global variable?
• What are the style requirements for methods?
  

int age = input.nextInt();

System.out.print("Enter your full name: ");

String name = input.nextLine();

What methods have we seen so far in this class?

• pow(base, exponent)
• sqrt(number)
• length()
• substring(start_index, end_index)
• charAt(index);
  
• nextLine(), nextInt(), etc
  
• Any others?

• What do they all have in common? Notice any similarities in their syntax?

• Method_name (Argument_List)

• Argument_List is a comma separated list:  (Argument_1, Argument_2, … , Argument_Last)   
  

side = Math.sqrt(area);
System.out.println("2.5 to the power 3.0 is "
         + Math.pow(2.5, 3.0));

Grouping Repeated Commands

• Some of the main() methods in our programs have been getting lengthy and complicated (See above activity with Strings!)
  
• The biggest problem in developing software is managing the complexity of programs
• We can improve our code by organizing it into smaller pieces known as methods
• Methods are a key tool in creating easy-to-understand programs that can be changed easily

Video: Chris Bosh Explains Functions (methods)

What is a Method?

• As developers, we need to know how to write and call methods

  Method = a named block of statements that can receive input, perform an action, and optionally return a value

• Methods are like little programs in our larger program
• We give each little method commands we want executed
• We call the method whenever we want the commands executed
• When the method has finished running, program execution returns to the point just after the code that called the method
  

Example Application for a Method

• As an example, recall our test code to validate user input:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

public static void main(String[] args) {
    double number = 0.0; // initialize value
    Scanner input = new Scanner(System.in);    

    while (number <= 0) {
        System.out.print("Enter a positive number: ");
        number = input.nextDouble();
        if (number <= 0.0) {
            System.out.println("You must enter a positive number\n");
        }
    }
    System.out.println("\nYou entered: " + number);

}

• What if we need to enter two validated numbers into a program?
• We want to process the first number after input and then input the second number
• Doing so, we would end up with code like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

public static void main(String[] args) {
    double number = 0.0; // initialize value
    Scanner input = new Scanner(System.in);    

    while (number <= 0) {
        System.out.print("Enter a positive number: ");
        number = input.nextDouble();
        if (number <= 0.0) {
            System.out.println("You must enter a positive number\n");
        }
    }
    System.out.println("\nYou entered: " + number);
    
    while (number <= 0) {
        System.out.print("Enter a second positive number: ");
        number = input.nextDouble();
        if (number <= 0.0) {
            System.out.println("You must enter a positive number\n");
        }
    }

    System.out.println("\nYou entered: " + number);

 }

• Our program would be easier to write if we could get the second input without repeating the code
• With methods, we give the list of commands a name and then run the list by calling the name
• Using methods we keep all the code in one place and avoid duplication
• Avoiding duplication reduces the complexity of our code and makes it easier to understand and change

Programming Style: Avoid Duplicating Code

• Duplicate code can lead to problems such as:
  • Long repeated sections that are more difficult to understand than shorter sequences
  • Repetition of largely identical code within which it is difficult to see the different purposes of each section
  • Update problems where we make changes in some sections but overlook making changes in other sections
• If we find ourselves writing similar code of three or more lines multiple times, we should consider writing a method
  

Defining a Method

• In this section we look at method definition syntax and examine a simple example method
  
• After we understand the syntax we can write more complicated methods

Method Syntax

• The general syntax for defining a method is:

  public static returnType methodName(parameter1, ..., parametern) {
      statements
  }
  

• Where:
  • returnType: the data type of the value returned
  • methodName: the name you make up for the method
    
  • parameterx: the input values, if any
  • statements: the list of statements to execute when the method is called

Example Program with a Method

• As an example, the following program has a simple method to add two numbers
• Notice that the code has two methods: add() and main()
• The second method add() can be placed anywhere outside of main().
  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

public static int add(int num1, int num2) {
    int sum = num1 + num2;
    return sum;
}
    
public static void main(String[] args) {
        
    int result;
    System.out.print("The sum of 2 and 5 is: ");
    result = add(2,5); //first "call" to the add method
    System.out.println(result);
        
    System.out.print("The sum or 7 and 9 is: ");
    result = add(7,9); //second "call" to the add method
    System.out.println(result);
}

Method Name

• Every method must have a name that identifies the method
  
• Method names follow the same rules as variable names
• Technically, we can use any valid identifier for a method name
• However, we should use a name that suggests the action the method performs
• In our example, add suggests that the method will return the sum of two numbers

Method Structure

• The first line of a method is known as the method signature

  public static int add(int a, int b)
  

• The curly braces {...} contain the method body
• The method body is the list of statement the method executes when called
• The method signature describes the name, inputs and output of a method
  
• We will look at these features in more detail in the following sections

Parameters

• When defining a method, it is worth thinking about what helpful action it will perform
• We can make the method more useful if we give it parameters
• The parameters for an add method would be the two numbers to sum
• Read through the following code to identify how the code makes use of the parameters

Example Code with Method Parameters

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

    public static int add(int num1, int num2) {
        int sum = num1 + num2;
        return sum;
    }
    
    public static void main(String[] args) {
        Scanner input = new Scanner(System.in);
        System.out.print("Enter two numbers to add: ");
        int num1 = input.nextInt();
        int num2 = input.nextInt();
        System.out.print("The sum of " +num1 + " and " + num2 + " is: ");
        int result = add(num1, num2);
        System.out.println(result);
        
    }

Parameter List

• We must have parenthesis after a method name
• Inside the parenthesis, we define a list of zero or more parameters
• Parameters are the inputs to a method
  
• In our example, we have two parameters inside the parenthesis

  int add(int a, int b)
  

• Parameters are the declaration of a new variable, even though they are declared inside parenthesis
• Each parameter must have both a type and a name, just like a regular variable
• If we have more than one parameter, we separate them with commas
• Any parameter that we declare must be given an argument when we call the method
  
• In the following image, the value of arguments num1 and num2 are copied to the parameters a and b

Passing Arguments to Method Parameters

Arguments and Parameters

• Depending on our background, we might use the term arguments or parameters for the values passed to methods
• The terminology is not that important
• However, the way I will use the terms is:
  • A method definition has parameters

    public static int add(int a, int b) { // a and b are parameters
        // ...
    }
    

  • A method call passes arguments

    add(num1, num2); // num1 and num2 are arguments
    

• Arguments are values we pass into methods
• When the argument drops into a method, it lands in a parameter
• A parameter is just like other variables in the method
  • Except that a parameter gets initialized by an argument
• The important part is:

  We must pass every method parameter an argument.

• The arguments must be in the same order as the parameters
• Also, the argument value must be compatible with the type of the parameter
• For example, we cannot call add() with: add("Jennifer", "Parrish")

Returning a Value

• The first word after public static in the method signature is the return type

  public static int add(int a, int b)
  

• The return type specifies the type of data the method outputs
• In our example the return type is an int

Return Statement

• Methods that return a value must execute a return statement

  return result;
  

• For instance, our example method add() has a return statement

  public static int add(int a, int b) {
      int sum = a + b;
      return sum;
  }
  

• Note that the type of the returned valued must be compatible with the method return type
• The returned value is substituted for the method call in the calling code

  sum =>[replaces]=> add(num1, num2)
  

• We must save the returned value if we want to process it later in the program

  int total = add(num1, num2);
  

Returning a Value from a Method

Returning an Expression

• The value after the word return can be an expression
• It does not have to be just the name of a variable
• We could rewrite our return statement to the following:

  return a + b;
  

Multiple return Statements

• We can have more than one return statement in a method
  
• The first return statement reached is the one executed
• We might have multiple returns if we have if-statements with alternate actions, like:

  if (x > 400) {
      return 1;
  } else {
      return 0;
  }
  

• We do not have alternate actions in our simple add method and so have only one return statement

Activity 16.1: Writing a Method (10 pts)

In this exercise we define our own method.

Specifications

1. Open a new Java project called Sub
   
2. Copy the following program method above or below your main method compile and run the starter program to make sure you copied it correctly.

   public static int add(int num1, int num2) {
      int sum = num1 + num2;
       return sum;
   }
   

3. Alter the signature for a method named sub that receives two int numbers and returns an int value, like we did for the add() method

   returnType sub(two_int_parameters)
   

4. Inside the method body, subtract the second parameter from the first and return the value, like we did for the add() method.

       int sum = num1 + num2; // from add() method, CHANGE THIS!
       return sum;
   

5. Compile and run your code. 
6. Inside the main() method, enter these statements:

       System.out.print("Enter two numbers to subtract: ");
       int num1 = input.nextInt();
       int num2 = input.nextInt();
       int diff = sub(num1, num2);
       System.out.println("Difference=" + diff);
   

   The fourth line contains the method call.
   

7. Compile and run your modified program and verify the output looks like:

   Enter two numbers to subtract: 3 1
   Difference=2
   

8. Save your file and submit it to Canvas.

Completed Program

When finished, your application should look like the following:

Variable Scope and Parameters

Variable and Parameter Scope

• A variable declared inside a method can only be used within that method

  Local variable: a variable that can only be accessed within a method or block.

• Parameters are a local variable and thus can only be used inside the method in which they are declared as well
• As an example of a local variable, we declared sum inside the add() method:

  int sum = a + b;
  

• In addition, we declared another variable named total inside main():

  int total = add(num1, num2);
  

• These variables cannot be accessed outside the method they were declared within

Scope

• The area of code that a variable can operate within is known as it's scope

  Scope: the enclosing area within which a variable exists

• Because of scope, we can use variables with the same name in different methods
• To send information to a methods we must include a parameters:

  public static int add(int a, int b)
  

• When the method call is made, we send the arguments to the parameters:

  add(num1, num2)
  

• The values of num1 and num2 are copied to the parameter variables a and b

Example of Scope - Below num1 and sum are out of scope.

Flow of Control for a Method Call

• To use methods well, we must understand their flow of control
• In our example, the program starts executing in the main() method
• When our program gets to the following statement, it stops executing in main() and jumps to our method:

  int total = add(num1, num2);
  

• The program executes the statements in the method and then returns to the statement from which it jumped
• When the method returns, the returned value replaces the method call
• After returning, the program completes processing the calling statement and then moves on to the next statement
• In our example, the statement saves the returned value in the variable: total
• Every time the flow of control reaches a method call, the program:
  1. Temporarily stops executing in the current method
     
  2. Jumps to the called method and executes the statements of that method
     
  3. Returns to the point in the code from which it jumped

Method Call Flow

1. Every program starts executing at the start of main().
2. When reaching a method call, arguments are copied to the parameters.
3. Method code executes until reaching a return statement.
4. Return statement returns a value to the method call.
5. Calling method continues after the method returns.

Activity 16.2: Tracing a Method Call (10 pts)

1. List the line numbers of each statement of your program from Activity 16.1 in the order the lines are executed. For example, if main() starts on line 9, statements are executed as follows:

   9, 10, 11, 12, ...
   

   Note: Do not bother to list blank lines or lines containing only a curly brace (}).

2. Submit your list of line numbers in the text box on Canvas for this activity.
   

Some Style Requirements for Methods Consider again our example method public static int add(int a, int b) {     int sum = a + b; return sum; } public static void main(String[] args) { Scanner input = new Scanner(System.in); System.out.print("Enter two numbers to add: "); int num1 = input.nextInt();     int num2 = input.nextInt(); int total = add(num1, num2); System.out.println("Sum=" + total); } Note the placement of the curly braces There are two common styles of curly brace placement for methods: Place the opening brace on the same line as the method heading: public static int myMethod() { // statements of the method } Place the opening brace under and lined up with the first letter of the return type: public static int myMethod() { // statements of the method } We can use either style as long as we are consistent Also notice the indentation of the statements inside the method As before, we always indent 3-4 more spaces after an opening curly brace After the closing curly brace, we no longer indent the extra 3-4 spaces Indenting makes it easier to see the block of code In addition, method names always start with a lower case letter like variables We can tell the difference between method and variable name because methods have parenthesis Activity 16.3: Calculating Your Salary (10 pts) Open up Eclipse and create a new Java project called Salary. Copy and paste the starter code below into the file. NOTE: Do not change the starter code! All you need to do is add to it. import java.util.Scanner; public class Salary {     //Write your methods here     public static void main(String[] args) {         Scanner input = new Scanner(System.in);         int hours;         double hourly_wage;         double weekly_salary = 0;         double monthly_salary = 0;         double yearly_salary = 0;         System.out.println("This program will calculate your weekly, monthly "                 + "and yearly salary!");         System.out.print("Please enter your hourly wage: ");         hourly_wage = input.nextDouble();         System.out.print("Please enter the number of hours you work each week: ");         hours = input.nextInt();         //call methods below         weekly_salary = //method call goes here         monthly_salary = //method call goes here         yearly_salary = //method call goes here                        System.out.printf("You make $%.2f per week\n", weekly_salary);         System.out.printf("You make $%.2f per month\n", monthly_salary);         System.out.printf("You make $%.2f per year\n", yearly_salary);            } } Now write three methods as follows and place them above main: weeklySalary():  Takes in an integer argument for the number of hours worked each week Takes in a double argument for the hourly wage Returns a double for the weekly salary monthlySalary():  Takes in an integer argument for the number of hours worked each week Takes in a double argument for the hourly wage Returns a double for the monthly salary yearlySalary():  Takes in an integer argument for the number of hours worked each week Takes in a double argument for the hourly wage Returns a double for the yearly salary Assume that you work 50 weeks a year (2 weeks vacation) Add a method call and store the result as the appropriate variable. weekly_salary = //method call goes here monthly_salary = //method call goes here yearly_salary = //method call goes here Now, run your code and verify that it prints the correct values for each salary type. When you are finished, upload your file to Canvas. Your output should look identical to the following (except user input will vary): Javadoc Comments Java also has a type of comment known as a Javadoc comment Javadoc comments are used to generate documentation automatically Syntax: /** * Description part of a Javadoc comment * * @tag Comment for the tag */ Note the extra star (*) in the opening of the comment Javadoc comments have two parts: Description of the code Followed by zero or more tags For example, you should put a Javadoc comment like the following at the beginning of every class: /** * Hello.java * Purpose: Prints a message to the screen. * * @author Jennifer Parrish * @version 1.4 6/2/16 */ In this example, we have two tags: @author followed by the name of the author @version followed by the version number or date Commenting Methods In addition, you put Javadoc comments like the following before every method: /** * The main method for the Hello program. * * @param args Not used */ Then you use a tool, known as Javadoc, to automatically create program documentation Also, a tool known as CheckStyle will check your comments (among other things) for correct usage For your homework, every method must have a Javadoc comment. Comments are for human readers, not compilers Your comments should be structured as follows Method comments start with /** and ends with */ The first line explains the idea of the method, not the implementation An @param entry explains each parameter An @return entry describes the return value The following example has two fully commented methods:     /**      * multiplies a number by itself      * @param number the number to square      * @return the squared number      */     public static double square(double number) {         double result = number * number;         return result;     }     /**      * Prints a date in the month/day/year format      * @param month the current month      * @param day the current day      * @param year the current year      */     public static void printDate(int month, int day, int year) {         System.out.println("The date: " + month + "/" + day + "/" + year);         return;     }     //Write your methods here     public static void main(String[] args) {         //method calls here     } Note that if you type /** above a method, Eclipse will help you fill in the rest. More Information How to Write Doc Comments for the JavadocTM Tool Javadoc Tags: for a list of @tags Activity 16.4: JavaDoc Comments (10 pts) Open up a text editor and create a new file named comments.txt. In the file, write the Javadoc comments for the following method. public static double areaTriangle(double base, double height) {     double area = 0.5 * base * height;     return area; } public static String myName(String firstName, char initial, String lastName) {     String fullName = firstName + " " + initial + ". " + lastName;     return fullName; } public static boolean isLeapYear(int year) {     if (year % 4 == 0) {         return true;     } else {         return false;     } } When you are finished, submit your comments.txt to Canvas. Wrap Up With your partner, answer the questions from today's learning objectives Upcoming Assignments Assignment 16 due Tuesday at 11:20am on Canvas Lab 8 due Friday! Midterm 2 next class