org.niffty
Class RiffStaff

java.lang.Object
  |
  +--org.niffty.RiffStaff

public class RiffStaff

extends java.lang.Object

A RiffStaff provides static methods for encoding/decoding a Staff using RIFF.

Method Summary

static Staff	maybeNew(RIFF parentInput) Peek into the parentInput's input stream and if the next item is a NIFF staff, return a new Staff.
static Staff	newInstance(RIFF parentInput) Creates new Staff from the parentInput's input stream.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static Staff newInstance(RIFF parentInput)
                         throws java.io.IOException,
                                RIFFFormatException

Creates new Staff from the parentInput's input stream. The next object in the input stream must be of this type. This also reads all the enclosed MeasureStartTimeSlice objects which themselves contain the event TimeSlice and MusicSymbol objects.

Parameters:

parentInput - the parent RIFF object being used to read the input stream

java.io.IOException

RIFFFormatException

maybeNew

public static Staff maybeNew(RIFF parentInput)
                      throws java.io.IOException,
                             RIFFFormatException

Peek into the parentInput's input stream and if the next item is a NIFF staff, return a new Staff. Otherwise, return null and leave the input stream unchanged.

Parameters:

parentInput - the parent RIFF object being used to read the input stream

java.io.IOException

RIFFFormatException