How to Return a 2D Array in Java?

In Java, returning a 2D array from a method can be a useful operation when dealing with complex data structures or performing various data manipulation tasks. In this section, we will delve into the details of how to return a 2D array in Java, providing step-by-step explanations and complete code examples.

2D Arrays in Java

Before we dive into the code, let's understand what a 2D array is in Java. A 2D array is essentially an array of arrays. It can be thought of as a grid or a matrix where each element is accessed using two indices: row and column. In Java, 2D arrays are declared and initialized as follows:

Here, the datatype is the type of data the array will hold, arrayName is the name of the array, rows is the number of rows, and columns are the number of columns.

Method 1: Returning and Printing a 2D Integer Array

IntMatrixExample.java

import java.util.Random;
public class IntMatrixExample {
    // Method to generate and return a 2D integer array
    public static int[][] generateRandomIntMatrix(int rows, int columns) {
        int[][] matrix = new int[rows][columns];
        Random random = new Random();
        for (int i = 0; i < rows; i++) {
            for (int j = 0; j < columns; j++) {
                matrix[i][j] = random.nextInt(100); // Filling with random integers between 0 and 99
            }
        }
        return matrix;
    }
    // Method to print a 2D integer array
    public static void printIntMatrix(int[][] matrix) {
        for (int[] row : matrix) {
            for (int value: row) {
                System.out.print(value + " ");
            }
            System.out.println();
        }
    }
    public static void main(String[] args) {
        int[][] intMatrix = generateRandomIntMatrix(3, 4);
        System.out.println("2D Integer Array:");
        printIntMatrix(intMatrix);
    }
}

Output:

2D Integer Array:
46 26 28 45 
60 63 61 56 
69 91 81 43

Method 2: Returning and Printing a 2D String Array

StringMatrixExample.java

public class StringMatrixExample {
    // Method to generate and return a 2D string array
    public static String[][] generateStringMatrix(int rows, int columns) {
        String[][] matrix = new String[rows][columns];
        for (int i = 0; i < rows; i++) {
            for (int j = 0; j < columns; j++) {
                matrix[i][j] = "Row " + i + ", Col " + j; // Filling with strings
            }
        }
        return matrix;
    }
    // Method to print a 2D string array
    public static void printStringMatrix(String[][] matrix) {
        for (String[] row : matrix) {
            for (String value: row) {
                System.out.print(value + " ");
            }
            System.out.println();
        }
    }
    public static void main(String[] args) {
        String[][] stringMatrix = generateStringMatrix(2, 3);
        System.out.println("2D String Array:");
        printStringMatrix(stringMatrix);
    }
}

Output:

2D String Array:
Row 0, Col 0 Row 0, Col 1 Row 0, Col 2 
Row 1, Col 0 Row 1, Col 1 Row 1, Col 2

Method 3: Returning and Printing a 2D Custom Object Array

CustomObject.java

class CustomObject {
    private String value;
    public CustomObject(String value) {
        this.value = value;
    }
    public String getValue() {
        return value;
    }
}

CustomObjectMatrixExample.java

public class CustomObjectMatrixExample {
    // Method to generate and return a 2D array of custom objects
    public static CustomObject[][] generateCustomObjectMatrix(int rows, int columns) {
        CustomObject[][] matrix = new CustomObject[rows][columns];
        for (int i = 0; i < rows; i++) {
            for (int j = 0; j < columns; j++) {
                matrix[i][j] = new CustomObject("Object at Row " + i + ", Col " + j);
            }
        }
        return matrix;
    }
    // Method to print a 2D array of custom objects
    public static void printCustomObjectMatrix(CustomObject[][] matrix) {
        for (CustomObject[] row : matrix) {
            for (CustomObject obj: row) {
                System.out.print(obj.getValue() + " ");
            }
            System.out.println();
        }
    }
    public static void main(String[] args) {
        CustomObject[][] customObjectMatrix = generateCustomObjectMatrix(2, 2);
        System.out.println("2D Custom Object Array:");
        printCustomObjectMatrix(customObjectMatrix);
    }
}

Output:

2D Custom Object Array:
Object at Row 0, Col 0 Object at Row 0, Col 1 
Object at Row 1, Col 0 Object at Row 1, Col 1

Returning a 2D Array with Different Data Types

If we need to return a 2D array of a different data type (for example, String, double, or custom objects), we can simply replace the int type with the desired data type in the method definition and adjust the data population logic accordingly.

Conclusion

Returning a 2D array in Java involves defining a method with a 2D array return type, initializing and populating the array within the method, and finally returning the filled 2D array. The capability can be invaluable when working with complex data structures or performing data manipulation tasks that require multi-dimensional arrays. Remember to adjust the data type and population logic according to your specific requirements, as demonstrated in the examples provided.

Next TopicJava 8 Stream.distinct() Method

← prev next →