|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.AbstractCollection | +--java.util.AbstractList | +--java.util.AbstractSequentialList | +--java.util.LinkedList | +--com.neoworks.jukex.tracksource.TrackSourcePipeline
A pipeline of TrackSources. This is the guts of the Track selection strategy for JukeX. Individual TrackSources are chained together and result in a stream of Tracks that can be requested by a player.
Field Summary |
Fields inherited from class java.util.AbstractList |
modCount |
Method Summary | |
void |
add(int index,
java.lang.Object element)
Add an element to the pipeline at a specified position |
boolean |
add(java.lang.Object element)
Add an element to the back of the pipeline |
boolean |
addAll(java.util.Collection c)
Add the contents of a Collection to the back of the pipeline |
boolean |
addAll(int index,
java.util.Collection c)
Add the contents of a Collection to the pipeline at a specified position |
void |
addFirst(java.lang.Object element)
Add an element to the head of the pipeline |
void |
addLast(java.lang.Object element)
Add an element to the back of the pipeline |
java.lang.String |
getDescription()
Return a String describing what, in general terms, this TrackSource does |
long |
getId()
Get the database ID of this TrackSourcePipeline |
java.lang.String |
getName()
Get the name of this TrackSourcePipeline |
Track |
getNextTrack()
Get the next track from the source. |
static TrackSourcePipeline |
getPipeline(java.lang.String name)
Get a pipeline by name, creating a new one if it does not exist |
java.lang.String |
getSummary()
Return a String summarising the configuration of the task the source is performing |
boolean |
isEnabled()
Pipelines are always enabled (at the moment) |
java.util.Iterator |
iterator()
Get an Iterator on this Pipeline |
java.util.ListIterator |
listIterator()
Get an Iterator on this Pipeline |
java.util.ListIterator |
listIterator(int index)
Get an Iterator on this Pipeline at a specific index |
java.util.List |
peekTracks(int count)
|
java.lang.Object |
remove(int index)
Remove the element at the specified position |
boolean |
remove(java.lang.Object element)
Remove the first occurence of an element from the pipeline |
java.lang.Object |
removeFirst()
Remove the first element in the pipeline |
java.lang.Object |
removeLast()
Remove the last element from the pipeline |
boolean |
restorePipeline()
Restore the state of the Pipeline (ie it's elements) from storage. |
java.lang.Object |
set(int index,
java.lang.Object element)
Replace the element at the specified position with the specified element |
boolean |
storePipeline()
Store the state of the Pipeline to the database |
java.lang.String |
toString()
Get a String representation of this Pipeline |
Methods inherited from class java.util.LinkedList |
clear, clone, contains, get, getFirst, getLast, indexOf, lastIndexOf, size, toArray, toArray |
Methods inherited from class java.util.AbstractList |
equals, hashCode, removeRange, subList |
Methods inherited from class java.util.AbstractCollection |
containsAll, isEmpty, removeAll, retainAll |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.neoworks.jukex.tracksource.TrackSource |
clone |
Methods inherited from interface java.util.List |
containsAll, equals, hashCode, isEmpty, removeAll, retainAll, subList |
Method Detail |
public static TrackSourcePipeline getPipeline(java.lang.String name)
name
- The name of the pipeline to get
public long getId()
public boolean isEnabled()
isEnabled
in interface TrackSource
public java.lang.String getName()
getName
in interface TrackSource
public Track getNextTrack()
getNextTrack
in interface TrackSource
public java.util.List peekTracks(int count)
public boolean restorePipeline()
public boolean storePipeline()
public void add(int index, java.lang.Object element)
add
in interface java.util.List
add
in class java.util.LinkedList
index
- The position to add the element atelement
- The TrackSourcePipelineElement to add
java.lang.ClassCastException
- If element is not a TrackSourcePipelineElement
java.lang.IndexOutOfBoundsException
- Self explanatorypublic boolean add(java.lang.Object element)
add
in interface java.util.List
add
in class java.util.LinkedList
element
- The TrackSourcePipelineElement to add
java.lang.ClassCastException
- If element is not a TrackSourcePipelineElementpublic boolean addAll(java.util.Collection c)
addAll
in interface java.util.List
addAll
in class java.util.LinkedList
c
- The Collection of TrackSourcePipelineElements
java.lang.ClassCastException
- If any of the elemtns in c are not TrackSourcePipelineElementspublic boolean addAll(int index, java.util.Collection c)
addAll
in interface java.util.List
addAll
in class java.util.LinkedList
c
- The Collection of TrackSourcePipelineElementsindex
- The position to insert the elements
java.lang.ClassCastException
- If any of the elemtns in c are not TrackSourcePipelineElements
java.lang.IndexOutOfBoundsException
- Self explanatorypublic void addFirst(java.lang.Object element)
addFirst
in class java.util.LinkedList
element
- The element to add
java.lang.ClassCastException
- If element is not a TrackSourcePipelineElementpublic void addLast(java.lang.Object element)
addLast
in class java.util.LinkedList
element
- The element to add
java.lang.ClassCastException
- If element is not a TrackSourcePipelineElementpublic java.lang.Object remove(int index)
remove
in interface java.util.List
remove
in class java.util.LinkedList
index
- The index of the element to remove
java.lang.IndexOutOfBoundsException
- Self explanatorypublic boolean remove(java.lang.Object element)
remove
in interface java.util.List
remove
in class java.util.LinkedList
element
- The object to remove
java.lang.IndexOutOfBoundsException
- Self explanatorypublic java.lang.Object removeFirst()
removeFirst
in class java.util.LinkedList
public java.lang.Object removeLast()
removeLast
in class java.util.LinkedList
public java.lang.Object set(int index, java.lang.Object element)
set
in interface java.util.List
set
in class java.util.LinkedList
index
- The position to setelement
- The TrackSourcePipelineElement to be stored
java.lang.IndexOutOfBoundsException
- index < 0 | index >= size()
java.lang.ClassCastException
- If element is not a TrackSourcePipelineElementpublic java.util.Iterator iterator()
iterator
in interface java.util.List
iterator
in class java.util.AbstractSequentialList
public java.util.ListIterator listIterator()
listIterator
in interface java.util.List
listIterator
in class java.util.AbstractList
public java.util.ListIterator listIterator(int index)
listIterator
in interface java.util.List
listIterator
in class java.util.LinkedList
index
- The index to begin at
public java.lang.String toString()
toString
in class java.util.AbstractCollection
public java.lang.String getDescription()
getDescription
in interface TrackSource
public java.lang.String getSummary()
getSummary
in interface TrackSource
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |