com.moppyandroid.main.service

Class MidiLibrary

java.lang.Object

com.moppyandroid.main.service.MidiLibrary

All Implemented Interfaces:

Map<String,MidiLibrary.MapNode>

public class MidiLibrary
extends Object
implements Map<String,MidiLibrary.MapNode>

Represents the MIDI file library of an Android device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MidiLibrary.Callback Callback interface used for running code upon completion of asynchronous MidiLibrary creation.
static class	MidiLibrary.Folder A structure representing a folder in a MidiLibrary.
static interface	MidiLibrary.MapNode Represents an entry in a MidiLibrary.Folder.
static class	MidiLibrary.MidiFile A structure representing a MIDI file that can be contained in a MidiLibrary.Folder.
protected static class	MidiLibrary.RootFolder Subclass of MidiLibrary.Folder that allows for a null name.

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALBUM_ICON_URI URI for the album icon.
static String	ALBUM_ID The ID of the folder containing the songs sorted by album.
static String	ARTIST_ICON_URI URI for the artist icon.
static String	ARTIST_ID The ID of the folder containing the songs sorted by artist.
protected static String	CLASS_NAME The package and name of the MidiLibrary class.
static String	FOLDER_ICON_URI URI for the default folder icon.
static String	MUSIC_FILE_ICON_URI URI for the music file icon.
static String	PATH_ID The ID of the folder containing the songs sorted by path.
static String	ROOT_ID The ID of the root folder.

Method Summary

Modifier and Type	Method and Description
void	clear() DISABLED METHOD Throws UnsupportedOperationException.
boolean	containsKey(Object key) Checks if the passed String is one of the names of the items in the root of this MIDI library.
boolean	containsValue(Object value) Checks if the passed MidiLibrary.MapNode is one of the items in the root of this MIDI library.
Set<Map.Entry<String,MidiLibrary.MapNode>>	entrySet() DISABLED METHOD throws UnsupportedOperationException.
MidiLibrary.MapNode	get(Object key) Gets the MidiLibrary.MapNode associated with the provided name.
static MidiLibrary	getMidiLibrary(Context context) Factory method for creating a MIDI library.
static void	getMidiLibraryAsync(Context context, MidiLibrary.Callback callback)
static boolean	hasStoragePermission(Context context) Checks if the provided context has permission to read external storage.
boolean	isEmpty() Checks if the root of this MIDI library is empty.
Set<String>	keySet() Gets the names of all items in the root of this MIDI library.
Set<String>	keySetRecursive() Gets the names of all dead-end items in this MIDI library, including those in subfolders.
MidiLibrary.MidiFile	put(String key, MidiLibrary.MapNode value) DISABLED METHOD Throws UnsupportedOperationException.
void	putAll(Map<? extends String,? extends MidiLibrary.MapNode> m) DISABLED METHOD Throws UnsupportedOperationException.
MidiLibrary.MidiFile	remove(Object key) DISABLED METHOD Throws UnsupportedOperationException.
static void	requestStoragePermission(Activity activity, int requestCode) Requests permission to read external storage for the provided activity.
MidiLibrary.MidiFile	searchFileFuzzy(String query) Searches for a MIDI file with a similar name
MidiLibrary.MidiFile	searchFileFuzzy(String query, Predicate<MidiLibrary.MidiFile> predicate) Searches for a MidiLibrary.MidiFile using a Predicate to allow the caller to specify attributes needed by a found MidiFile to be considered valid.
int	size() Gets the number of items in the root of this MIDI library.
Collection<MidiLibrary.MapNode>	values() Gets all of the MidiLibrary.MapNode objects in the root of this MIDI library
Collection<MidiLibrary.MapNode>	valuesRecursive() Gets all of the dead-end MidiLibrary.MapNode objects in this MIDI library, including those in subfolders.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

CLASS_NAME

protected static final String CLASS_NAME

The package and name of the MidiLibrary class. Refactors must ensure this is accurate.

See Also:

Constant Field Values

ROOT_ID

public static final String ROOT_ID

The ID of the root folder.

See Also:

Constant Field Values

PATH_ID

public static final String PATH_ID

The ID of the folder containing the songs sorted by path.

See Also:

Constant Field Values

ALBUM_ID

public static final String ALBUM_ID

The ID of the folder containing the songs sorted by album.

See Also:

Constant Field Values

ARTIST_ID

public static final String ARTIST_ID

The ID of the folder containing the songs sorted by artist.

See Also:

Constant Field Values

FOLDER_ICON_URI

public static final String FOLDER_ICON_URI

URI for the default folder icon.

ALBUM_ICON_URI

public static final String ALBUM_ICON_URI

URI for the album icon.

ARTIST_ICON_URI

public static final String ARTIST_ICON_URI

URI for the artist icon.

MUSIC_FILE_ICON_URI

public static final String MUSIC_FILE_ICON_URI

URI for the music file icon.

Method Detail

hasStoragePermission

public static boolean hasStoragePermission(Context context)

Checks if the provided context has permission to read external storage.

Parameters:

context - the context to check

Returns:

true if permission has been granted, otherwise false

requestStoragePermission

public static void requestStoragePermission(Activity activity,
                                            int requestCode)

Requests permission to read external storage for the provided activity.

Parameters:

activity - the activity to request permission on

getMidiLibrary

@Nullable
public static MidiLibrary getMidiLibrary(Context context)

Factory method for creating a MIDI library.

Parameters:

context - the context to use for retrieving files

Returns:

null if read permission has not been granted, otherwise a valid MIDI library

getMidiLibraryAsync

public static void getMidiLibraryAsync(Context context,
                                       MidiLibrary.Callback callback)

size

public int size()

Gets the number of items in the root of this MIDI library.

Specified by:

size in interface Map<String,MidiLibrary.MapNode>

Returns:

the number of children in the root folder

isEmpty

public boolean isEmpty()

Checks if the root of this MIDI library is empty.

Specified by:

isEmpty in interface Map<String,MidiLibrary.MapNode>

Returns:

true if the library is empty, otherwise false

containsKey

public boolean containsKey(Object key)

Checks if the passed String is one of the names of the items in the root of this MIDI library.

Specified by:

containsKey in interface Map<String,MidiLibrary.MapNode>

Parameters:

key - the name to check for

Returns:

true if key is the name of a root item, false otherwise

containsValue

public boolean containsValue(Object value)

Checks if the passed MidiLibrary.MapNode is one of the items in the root of this MIDI library.

Specified by:

containsValue in interface Map<String,MidiLibrary.MapNode>

Parameters:

value - the MapNode object to check for

Returns:

true if value is a root item, false otherwise

get

@Nullable
public MidiLibrary.MapNode get(Object key)

Gets the MidiLibrary.MapNode associated with the provided name.

Specified by:

get in interface Map<String,MidiLibrary.MapNode>

Parameters:

key - the name of the item to retrieve

Returns:

null if the item wasn't found, the requested MapNode otherwise

put

@Nullable
public MidiLibrary.MidiFile put(String key,
                                           MidiLibrary.MapNode value)

DISABLED METHOD
Throws UnsupportedOperationException.

Specified by:

put in interface Map<String,MidiLibrary.MapNode>

remove

@Nullable
public MidiLibrary.MidiFile remove(@Nullable
                                              Object key)

DISABLED METHOD
Throws UnsupportedOperationException.

Specified by:

remove in interface Map<String,MidiLibrary.MapNode>

putAll

public void putAll(@NonNull
                   Map<? extends String,? extends MidiLibrary.MapNode> m)

DISABLED METHOD
Throws UnsupportedOperationException.

Specified by:

putAll in interface Map<String,MidiLibrary.MapNode>

clear

public void clear()

DISABLED METHOD
Throws UnsupportedOperationException.

Specified by:

clear in interface Map<String,MidiLibrary.MapNode>

keySet

@NonNull
public Set<String> keySet()

Gets the names of all items in the root of this MIDI library.

Specified by:

keySet in interface Map<String,MidiLibrary.MapNode>

Returns:

the Set of keys for all root items

keySetRecursive

@NonNull
public Set<String> keySetRecursive()

Gets the names of all dead-end items in this MIDI library, including those in subfolders. For a more detailed explanation of dead-end items, see MidiLibrary.Folder.getKeysRecursive().

Returns:

the Set of all item names

values

@NonNull
public Collection<MidiLibrary.MapNode> values()

Gets all of the MidiLibrary.MapNode objects in the root of this MIDI library

Specified by:

values in interface Map<String,MidiLibrary.MapNode>

Returns:

the Collection of root items

valuesRecursive

@NonNull
public Collection<MidiLibrary.MapNode> valuesRecursive()

Gets all of the dead-end MidiLibrary.MapNode objects in this MIDI library, including those in subfolders. For a more detailed explanation of dead-end objects, see MidiLibrary.Folder.getChildrenRecursive()

Returns:

the Collection of all items

entrySet

@NonNull
public Set<Map.Entry<String,MidiLibrary.MapNode>> entrySet()

DISABLED METHOD
throws UnsupportedOperationException.

Specified by:

entrySet in interface Map<String,MidiLibrary.MapNode>

searchFileFuzzy

@Nullable
public MidiLibrary.MidiFile searchFileFuzzy(String query)

Searches for a MIDI file with a similar name

Parameters:

query - the name to search for

Returns:

null if query didn't match any files, otherwise the first matched file

searchFileFuzzy

@Nullable
public MidiLibrary.MidiFile searchFileFuzzy(String query,
                                                       Predicate<MidiLibrary.MidiFile> predicate)

Searches for a MidiLibrary.MidiFile using a Predicate to allow the caller to specify attributes needed by a found MidiFile to be considered valid.

e.g. predicate could be (file) -> { return file.getAlbum() == "Greatest Hits"; }

Parameters:

query - the name of the file to search for

predicate - the functional interface used to validate a matching MidiFile

Returns:

null if no matching files were found, otherwise the first matched file