Groovy - List shuffled() method

---

---

Description

Groovy List shuffled() method returns the a List with elements of the current list reordered in the random order. Original List is unchanged.

Syntax

public List shuffled()

Parameters

NA

Return Value

The shuffled list.

Example - Shuffling a List of Integers

Following is an example of the usage of this method −

main.groovy

def lst = [11, 12, 13, 14]; 

def shuffledList = lst.shuffled(); 
println(lst);
println(shuffledList);  

Output

When we run the above program, we will get the following result −

[11, 12, 13, 14]
[12, 13, 11, 14]

Example - Shuffling a List of Strings

Following is an example of the usage of this method −

main.groovy

def lst = ["Apple", "Peach", "Orange", "Mango"]; 

def shuffledList = lst.shuffled(); 
println(lst);
println(shuffledList);  

Output

When we run the above program, we will get the following result −

[Apple, Peach, Orange, Mango]
[Mango, Apple, Orange, Peach]

Example - Shuffling a List of Objects

Following is an example of the usage of this method −

main.groovy

def lst = [new Student(1, "Julie"),new Student(2, "Robert"),new Student(3, "Adam")];

def shuffledList = lst.shuffled(); 
println(lst);
println(shuffledList);     

class Student {
   int rollNo;
   String name;

   Student(int rollNo, String name){
      this.rollNo = rollNo;
      this.name = name;
   }

   @Override
   public boolean equals(Object obj) {
      Student s = (Student)obj;
      return this.rollNo == s.rollNo && this.name.equalsIgnoreCase(s.name);
   }
   
   @Override
   public String toString() {
      return "[ " + this.rollNo + ", " + this.name + " ]";
   }
}

Output

When we run the above program, we will get the following result −

[[ 1, Julie ], [ 2, Robert ], [ 3, Adam ]]
[[ 2, Robert ], [ 3, Adam ], [ 1, Julie ]]