Welcome to Method Signatures!

Think of a method signature as a "contract" or an "ID card" for a specific piece of code. Before you can use a tool in Java, you need to know exactly how to talk to it. In this chapter, we will learn how to read these "ID cards" so you can use methods correctly in your programs. Don't worry if it looks like a foreign language at first—once you know the pattern, it's as easy as reading a recipe!

What is a Method Signature?

In Java, a method is a block of code that performs a specific task. A method signature is the part of the method declaration that tells the computer (and you!) exactly what the method needs to do its job and what it will give back to you. When you look at documentation, like a manual for a car, the signature tells you which buttons to press and what happens when you press them.

According to the AP Computer Science A syllabus, a method signature consists of three main parts:

  1. The Method Name
  2. The Parameter List
  3. The Return Type

Note: For now, we are focusing on how to read these signatures in documentation so you can call them in your code.

1. The Method Name

The method name is the unique label used to call the method. In Java, we use a style called lowerCamelCase. This means the first letter is lowercase, and every word after that starts with a capital letter.

Examples:

  • \( \text{calculateTotal} \)
  • \( \text{nextBoolean} \)
  • \( \text{substring} \)

2. The Parameter List

The parameter list is found inside the parentheses \( \text{()} \) following the method name. It tells you what information the method needs to function. Think of these as the "ingredients" for a recipe.

  • If the parentheses are empty \( \text{()} \), the method requires no information.
  • If there are items inside, they are listed as (type name).
  • If there are multiple items, they are separated by commas.

Real-World Analogy: Imagine a microwave. A method called \( \text{heatFood(int seconds)} \) needs you to provide an integer (the number of seconds) before it can start.

AP Tip: In Unit 1, you only need to worry about the three examinable primitive types: int, double, and boolean, as well as object types like String.

3. The Return Type

The return type tells you what kind of data the method sends back to you after it finishes its job. It is located just before the method name in documentation.

  • If a method returns an int, you can save that result in an integer variable.
  • If a method says void, it means the method performs an action but sends nothing back.

Example: If you have a method \( \text{public int getAge()} \), the return type is int. You can expect a whole number back.

Reading Signatures in Documentation

Let’s look at a signature you might see in the official Java Quick Reference for the Math class or the String class:

\( \text{double sqrt(double x)} \)

How to break this down:

  • Return Type: \( \text{double} \) (It will give you a decimal number back).
  • Method Name: \( \text{sqrt} \) (Short for square root).
  • Parameter: \( \text{double x} \) (You must provide it with one decimal number to work with).

Another Example:

\( \text{int indexOf(String str)} \)

  • Return Type: \( \text{int} \) (It gives you a whole number representing a position).
  • Method Name: \( \text{indexOf} \).
  • Parameter: \( \text{String str} \) (You must provide it with a String).

Common Pitfalls to Avoid

Mistake 1: Forgetting the Order
If a method signature is \( \text{substring(int from, int to)} \), you must provide two integers in that exact order. You cannot provide a double or a String, and you cannot provide just one number if the signature requires two.

Mistake 2: Ignoring "void"
If a method is void, you cannot try to save its result into a variable. For example, if a method is \( \text{void printGreeting()} \), writing \( \text{String s = printGreeting();} \) will cause an error because there is nothing to "catch."

Mistake 3: Confusing Types
Remember that Java is very strict. If a signature asks for an \( \text{int} \), giving it a \( \text{double} \) (like \( \text{5.5} \)) will often cause an error because the decimal part won't fit!

Quick Review Box

Key Takeaways:

  • The Signature is the method's "Header."
  • Return Type: What you get back (or void for nothing).
  • Method Name: Use lowerCamelCase.
  • Parameter List: The inputs required inside the \( \text{()} \).
  • Focus: In this unit, we use documentation to ensure we call methods with the correct number and type of values.

Next Steps: Now that you can read a signature, you are ready to learn how to actually call these methods in "Calling Class Methods" and "Calling Instance Methods"!