Question

(Java)

Question about commenting my source code

/**
 * Array of MP3 object which have specific artist as a property.
 * @param artist        name of artist
 * @param title         name of the MP3
 * @return              array of MP3 objects
 */
public MP3[] search(String artist, String title)
{ ... }

What is the search method? Does the method: public MP3[] search(String artist, String title) { ... } work?

Answer 1

public MP3[] search(String artist, String title)
   {
       // Note: at worst the maximum number of returned songs is the length of the library
       //       Inefficient. Consider using java.util.ArrayList instead.
       MP3 [] foundSongs = new MP3[library.length];
       int numFound = 0;
      
       for (int i = 0; i < library.length; i++)
       {
           MP3 current = library[i];

           String currentTitle = library[i].getTitle();

           String currentArtist = library[i].getArtist();

           if (currentTitle.equals(title) && currentArtist.equals(artist))
               foundSongs[numFound++] = current;          
       }

       if (numFound == 0)
           return null;
       return foundSongs; // Might consider using Arrays.copyOf to return a MP3[] with the correct length.
}