MidiLibrary.MapNode

All Superinterfaces:

Comparable<MidiLibrary.MapNode>

All Known Implementing Classes:

MidiLibrary.Folder, MidiLibrary.MidiFile, MidiLibrary.RootFolder

Enclosing class:

MidiLibrary
```
public static interface MidiLibrary.MapNode
extends Comparable<MidiLibrary.MapNode>
```
Represents an entry in a MidiLibrary.Folder.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Set<MidiLibrary.MapNode>`	`getChildren()` Gets all of the children of this `MapNode`.
`int`	`getChildrenCount()` Gets the number of children this `MapNode` contains.
`Set<MidiLibrary.MapNode>`	`getChildrenRecursive()` Recursively gets all the children of this `MapNode`, including those contained in `MidiLibrary.Folder`-like structures stored in this `MapNode`.
`Set<String>`	`getKeys()` Gets the names of all direct children of this `MapNode`.
`Set<String>`	`getKeysRecursive()` Recursively gets the names of all the children of this `MapNode`, including those contained in `MidiLibrary.Folder`-like structures stored in this `MapNode`.
`MediaMetadataCompat`	`getMetadata()` Gets the metadata of this `MapNode`.
`String`	`getName()` Gets the name of this `MapNode`.
`String`	`getNameGlobal()` Gets the fully-qualified name of this `MapNode`.
`String`	`getParentName()` Returns the fully-qualified name of this `MapNode`'s parent, or `null` if the `MapNode` doesn't have a parent. To expand on the example provided at `getNameGlobal()`, `getParentName` would return `ROOT_FOLDER/Music/Folk/Korobeiniki`.
`boolean`	`hasChildren()` Checks if this `MapNode` has any children.
`boolean`	`isFile()` Checks whether this `MapNode` is a "file" or "folder", where a folder is defined as any `MapNode` implementation that stores other `MapNode`s, and a file is defined as any other implementation. Implementers must override to always return `true` or `false` in compliance with the above contract.

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - hasChildren
```
boolean hasChildren()
```
    Checks if this MapNode has any children.
    
    Returns:
    
    true if this MapNode has children, otherwise false
  - getChildren
```
Set<MidiLibrary.MapNode> getChildren()
```
    Gets all of the children of this MapNode. Returns null if the MapNode's implementation doesn't store children.
    
    Returns:
    
    null if the MapNode implementation doesn't store children, otherwise the Set of all children
  - getChildrenRecursive
```
Set<MidiLibrary.MapNode> getChildrenRecursive()
```
    Recursively gets all the children of this MapNode, including those contained in MidiLibrary.Folder-like structures stored in this MapNode. Returns null if the MapNode's implementation doesn't store children.
    
    Returns:
    
    the Set of all descendants
    
    See Also:
    
    MidiLibrary.Folder.getChildrenRecursive()
  - getChildrenCount
```
int getChildrenCount()
```
    Gets the number of children this MapNode contains. Returns -1 if the implementation doesn't store children.
    
    Returns:
    
    -1 if children aren't supported, otherwise the number of stored children
  - getKeys
```
Set<String> getKeys()
```
    Gets the names of all direct children of this MapNode. Returns null if the implementation doesn't store children
    
    Returns:
    
    the Set of all children names
  - getKeysRecursive
```
Set<String> getKeysRecursive()
```
    Recursively gets the names of all the children of this MapNode, including those contained in MidiLibrary.Folder-like structures stored in this MapNode. Returns null if the MapNode's implementation doesn't store children
    
    Returns:
    
    the Set of all names of children which have no children
  - isFile
```
boolean isFile()
```
    Checks whether this MapNode is a "file" or "folder", where a folder is defined as any MapNode implementation that stores other MapNodes, and a file is defined as any other implementation.
    
    Implementers must override to always return true or false in compliance with the above contract.
    
    Returns:
    
    true if the implementation stores MapNodes, otherwise false
  - getName
```
String getName()
```
    Gets the name of this MapNode.
    
    Returns:
    
    the name
  - getNameGlobal
```
String getNameGlobal()
```
    Gets the fully-qualified name of this MapNode. This name includes all parent path segments leading up to the root directory.
    
    For example, a MidiLibrary.MidiFile {code Tetris.mid} could be housed in a tree of MidiLibrary.Folders:
    - ROOT_FOLDER -> Music -> Folk -> Korobeiniki -> Tetris.mid
    The getName method must return Tetris.mid, and the getNameGlobal method must return ROOT_FOLDER/Music/Folk/Korobeiniki/Tetris.mid.
    Returns:
    
    the global name
  - getMetadata
```
MediaMetadataCompat getMetadata()
```
    Gets the metadata of this MapNode.
    
    Returns:
    
    the metadata
  - getParentName
```
String getParentName()
```
    Returns the fully-qualified name of this MapNode's parent, or null if the MapNode doesn't have a parent.
    
    To expand on the example provided at getNameGlobal(), getParentName would return ROOT_FOLDER/Music/Folk/Korobeiniki.
    
    Returns:
    
    the global name of the parent

Interface MidiLibrary.MapNode

Method Summary

Methods inherited from interface java.lang.Comparable

Method Detail

hasChildren

getChildren

getChildrenRecursive

getChildrenCount

getKeys

getKeysRecursive

isFile

getName

getNameGlobal

getMetadata

getParentName