com.moppyandroid.main.service

Class MidiLibrary.Folder

java.lang.Object

com.moppyandroid.main.service.MidiLibrary.Folder

All Implemented Interfaces:

MidiLibrary.MapNode, Comparable<MidiLibrary.MapNode>

Direct Known Subclasses:

MidiLibrary.RootFolder

Enclosing class:

MidiLibrary

public static class MidiLibrary.Folder
extends Object
implements MidiLibrary.MapNode

A structure representing a folder in a MidiLibrary. Backed by a TreeMap.

Constructor Summary

Constructors

Constructor and Description
Folder(String folderName, String parentName, String iconUri) Constructs a new Folder.

Method Summary

Modifier and Type	Method and Description
void	addChild(MidiLibrary.MapNode node) Adds a MidiLibrary.MapNode to this Folder.
MidiLibrary.Folder	clone() Creates a new Folder with the same properties as this Folder.
int	compareTo(MidiLibrary.MapNode node) Compares this Folder with another MidiLibrary.MapNode and determines which should be sorted first.
boolean	containsKey(String key) Checks if a String is the name of an item that is a direct child of this Folder.
boolean	containsValue(MidiLibrary.MapNode value) Checks if a MidiLibrary.MapNode is a direct child of this Folder.
MidiLibrary.MidiFile	createFile(Uri uri, String fileName, int duration, String artist, String album, String path) Creates a MidiLibrary.MidiFile in this Folder.
MidiLibrary.Folder	createFolder(String folderName) Creates a Folder with the default icon.
MidiLibrary.Folder	createFolder(String folderName, String iconUri) Creates a Folder with a specific icon.
static MidiLibrary.Folder	createFolderStructureWithFile(MidiLibrary.MidiFile midiFile, String iconUri) Creates a folder to house the provided MidiLibrary.MidiFile.
MidiLibrary.MapNode	get(String key) Gets a child of this Folder.
Set<MidiLibrary.MapNode>	getChildren() Gets all of the children of this Folder.
int	getChildrenCount() Gets the number children this Folder has.
Set<MidiLibrary.MapNode>	getChildrenRecursive() Recursively gets all the dead-end children of this Folder.
Set<MidiLibrary.Folder>	getFoldersRecursive() Gets all of the subfolders contained in this Folder.
String	getIconUri() Gets the URI of the icon this Folder uses.
Set<String>	getKeys() Gets the names of all direct children of this Folder.
Set<String>	getKeysRecursive() Recursively gets the names of all dead-end children children of this Folder.
MediaMetadataCompat	getMetadata() Gets the metadata of this Folder.
String	getName() Gets the name of this Folder.
String	getNameGlobal() Gets the fully-qualified name of this Folder.
String	getParentName() Gets the fully-qualified name of this Folder's parent.
boolean	hasChildren() Checks if this Folder has any children.
boolean	isFile() Always returns false.
MidiLibrary.MapNode	remove(String key) Removes a child of this Folder.
protected String	validateFolderNames(String folderName, String parentName) Verifies the passed folder and parent names.

Methods inherited from class java.lang.Object

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

Constructor Detail

Folder

public Folder(String folderName,
              String parentName,
              String iconUri)

Constructs a new Folder.

Parameters:

folderName - the name to use for this Folder

parentName - the fully-qualified name of the parent MidiLibrary.Folder, use null if there is no parent

iconUri - the URI String of the icon to use for this Folder

Method Detail

createFolderStructureWithFile

@Nullable
public static MidiLibrary.Folder createFolderStructureWithFile(MidiLibrary.MidiFile midiFile,
                                                                          String iconUri)
                                                                   throws InvalidPathException

Creates a folder to house the provided MidiLibrary.MidiFile. The default folder icon is used for all new folders.

Parameters:

midiFile - the file to create folders to contain

iconUri - the URI String of the icon to use for the folders; use null for default icon

Returns:

null if no folders are in file path

Throws:

InvalidPathException - if a segment of the path is blank

validateFolderNames

protected String validateFolderNames(String folderName,
                                     String parentName)
                              throws InvalidPathException

Verifies the passed folder and parent names. Override to change acceptable names. This implementation breaks down the path segments of folderName and creates subdirectories.

Parameters:

folderName - the requested folder name

parentName - the fully-qualified name of the parent folder

Returns:

the processed folder name

Throws:

IllegalArgumentException - if folderName is null

InvalidPathException - if a segment of folderName already represents a non-Folder entry

See Also:

MidiLibrary.RootFolder

createFolder

public MidiLibrary.Folder createFolder(String folderName)

Creates a Folder with the default icon. If the requested Folder already exists, that Folder is returned.

Parameters:

folderName - the name or relative path of the folder to create

Returns:

the created/found Folder

Throws:

InvalidPathException - if folderName already is a non-Folder entry

See Also:

createFolder(String, String)

createFolder

public MidiLibrary.Folder createFolder(String folderName,
                                       String iconUri)
                                throws InvalidPathException

Creates a Folder with a specific icon. If the requested Folder already exists, that Folder is returned and the supplied icon is ignored.

Parameters:

folderName - the name or relative path of the folder to create

iconUri - the URI String of the icon to use for the folders; use null for default icon

Returns:

the created/found Folder

Throws:

InvalidPathException - if folderName already is a non-Folder entry

createFile

public MidiLibrary.MidiFile createFile(Uri uri,
                                       String fileName,
                                       int duration,
                                       String artist,
                                       String album,
                                       String path)
                                throws InvalidPathException

Creates a MidiLibrary.MidiFile in this Folder.

Parameters:

uri - the Uri that can be used to open the file

fileName - the file's name

duration - the duration (in milliseconds)

artist - the file's artist

album - the file's album

Returns:

the created file

Throws:

InvalidPathException - if fileName already exists

addChild

public void addChild(@Nullable
                     MidiLibrary.MapNode node)
              throws InvalidPathException

Adds a MidiLibrary.MapNode to this Folder. If a MapNode with the same name as node already exists and they are both Folders, they are combined; if they are not both Folders, an InvalidPathException is raised.

Parameters:

node - the MapNode to be added

Throws:

InvalidPathException - if node already exists and both aren't Folders

get

public MidiLibrary.MapNode get(String key)

Gets a child of this Folder.

Parameters:

key - the name or relative path of the requested item

Returns:

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

remove

public MidiLibrary.MapNode remove(String key)

Removes a child of this Folder.

Parameters:

key - the name or relative path of the item to be removed

Returns:

null if the item wasn't found, otherwise the removed item as a MapNode

containsKey

public boolean containsKey(String key)

Checks if a String is the name of an item that is a direct child of this Folder.

Parameters:

key - the name of the item

Returns:

true if key is the name of an item is in this Folder, otherwise false

containsValue

public boolean containsValue(MidiLibrary.MapNode value)

Checks if a MidiLibrary.MapNode is a direct child of this Folder.

Parameters:

value - the item to check for

Returns:

true if value is an item is in this Folder, otherwise false

clone

@NonNull
public MidiLibrary.Folder clone()

Creates a new Folder with the same properties as this Folder.

Overrides:

clone in class Object

Returns:

this Folder's clone

getFoldersRecursive

public Set<MidiLibrary.Folder> getFoldersRecursive()

Gets all of the subfolders contained in this Folder.

Returns:

A Set containing all subfolders

getIconUri

public String getIconUri()

Gets the URI of the icon this Folder uses.

Returns:

the URI as a String

hasChildren

public boolean hasChildren()

Checks if this Folder has any children.

Specified by:

hasChildren in interface MidiLibrary.MapNode

Returns:

true if this Folder has children, otherwise false

getChildren

public Set<MidiLibrary.MapNode> getChildren()

Gets all of the children of this Folder.

Specified by:

getChildren in interface MidiLibrary.MapNode

Returns:

the Set of all children

getChildrenRecursive

public Set<MidiLibrary.MapNode> getChildrenRecursive()

Recursively gets all the dead-end children of this Folder. In other words, any MidiLibrary.MapNodes without children (e.g. an empty Folder or a MidiLibrary.MidiFile) are found and returned.

Specified by:

getChildrenRecursive in interface MidiLibrary.MapNode

Returns:

the Set of all children which have no children

See Also:

getChildrenRecursive()

getChildrenCount

public int getChildrenCount()

Gets the number children this Folder has.

Specified by:

getChildrenCount in interface MidiLibrary.MapNode

Returns:

the size of the children table

getKeys

public Set<String> getKeys()

Gets the names of all direct children of this Folder.

Specified by:

getKeys in interface MidiLibrary.MapNode

Returns:

the Set of all children names

getKeysRecursive

public Set<String> getKeysRecursive()

Recursively gets the names of all dead-end children children of this Folder. In other words, the names of any MidiLibrary.MapNodes without children (e.g. an empty Folder or a MidiLibrary.MidiFile) are found and returned.

Specified by:

getKeysRecursive in interface MidiLibrary.MapNode

Returns:

the Set of all names of children which have no children

isFile

public boolean isFile()

Always returns false.

Specified by:

isFile in interface MidiLibrary.MapNode

Returns:

false

getName

public String getName()

Gets the name of this Folder.

Specified by:

getName in interface MidiLibrary.MapNode

Returns:

the name

getNameGlobal

public String getNameGlobal()

Gets the fully-qualified name of this Folder.

Specified by:

getNameGlobal in interface MidiLibrary.MapNode

Returns:

the global name

getParentName

public String getParentName()

Gets the fully-qualified name of this Folder's parent.

Specified by:

getParentName in interface MidiLibrary.MapNode

Returns:

the parent's global name

getMetadata

public MediaMetadataCompat getMetadata()

Gets the metadata of this Folder.

Specified by:

getMetadata in interface MidiLibrary.MapNode

Returns:

the metadata

compareTo

public int compareTo(MidiLibrary.MapNode node)

Compares this Folder with another MidiLibrary.MapNode and determines which should be sorted first. Case is ignored.

Specified by:

compareTo in interface Comparable<MidiLibrary.MapNode>

Parameters:

node - the MapNode to compare against

Returns:

negative integer if this Folder should be sorted first, 0 if the objects should be sorted equally, or a positive integer if node should be sorted first