Question

Write a review on code below. The primary areas to focus on when doing a code review include the following: General Unit Testing, Comment and Coding Conventions, Error Handling, Resource Leaks, Performance, Functionality, and Security

Code:

package snhu.student.playlists;

import snhu.jukebox.playlist.PlayableSong;

import snhu.jukebox.playlist.Song;

import music.artist.*;

import java.util.ArrayList;

import java.util.LinkedList;

public class BrandonRickman_Playlist {

    public LinkedList<PlayableSong> StudentPlaylist(){

    

    // Creates a new array object list of playable songs

    LinkedList<PlayableSong> playlist = new LinkedList<PlayableSong>();

    

    // Creates a new call to an artist file and adds songs to play list

    ArrayList<Song> Blink182Tracks = new ArrayList<Song>();

Blink_182 b182 = new Blink_182();

Blink182Tracks = b182.getBlink_182Songs();

    

    playlist.add(Blink182Tracks.get(0));

    playlist.add(Blink182Tracks.get(2));

    

    // Creates a new call to another artist and adds songs to play list

    ArrayList<Song> GodsmackTracks = new ArrayList<Song>();

    Godsmack g = new Godsmack();

    GodsmackTracks = g.getGodsmackSongs();

    

    playlist.add(GodsmackTracks.get(0));

    playlist.add(GodsmackTracks.get(1));

    playlist.add(GodsmackTracks.get(2));

    

    // Creates a new call to another artist and adds songs to play list

    ArrayList<Song> VolbeatTracks = new ArrayList<Song>();

    Volbeat v = new Volbeat();

    VolbeatTracks = v.getVolbeatSongs();

    

    playlist.add(VolbeatTracks.get(0));

    playlist.add(VolbeatTracks.get(1));

    playlist.add(VolbeatTracks.get(2));

    

return playlist;

    }

}

Answer 1

General Unit Testing :

Break down into method names like :

public LinkedList<PlayableSong> playlist getArtistsTracks(List<Song> tracks, int[] songIndexes){

//Add the music tracks to the playlist

}

You could write tests for this method easily and use

assertTrue(getArtistsTracks(arg1 , arg2 ), playlist.get(0));

2. Comment and Coding Convention

For Class names BrandonRickman_Playlist avoid using underscores . using camel case letters

Method name StudentPlaylist() should also have lower case letters .

3. Error Handling

The b182.getBlink_182Songs(); can return null or empty List which would throw null pointer exception .

After creating the object here -> Blink_182 b182 = new Blink_182(); , Godsmack g = new Godsmack(); , Volbeat v = new Volbeat(); check for the null exceptions .

or use Optional.of(obj).orElse(new Blink_182()); example .

Ensure PlayableSong class exists as it will throw nosuchelement Exception

4. Resource Leaks - > So far there seems to be no file handlers Input or Output file readers or writers neither database connections . No resource leaks so far.

5. Performance - LinkedList gives O(1) for insertion and deletions which seems to be used rightly when adding to PlayableSong. ArrayList gives O(1) constant time search using indexes .

6. Functionality - Achieves the desired functionality .

7. Security : Use role based access for creating and adding songs to the playlist. Use Collections.unmodifiableList(PlayLists) when storing it in the database or sending across as a stream .