org.niffty
Class RiffKeySignature

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

public class RiffKeySignature

extends java.lang.Object

A RiffKeySignature provides static methods for encoding/decoding a KeySignature using RIFF.

Method Summary

static KeySignature	maybeNew(RIFF parentInput) Peek into the parentInput's input stream and if the next item is a NIFF key signature, return a new KeySignature.
static KeySignature	newInstance(RIFF parentInput) Creates new KeySignature 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 KeySignature newInstance(RIFF parentInput)
                                throws java.io.IOException,
                                       RIFFFormatException

Creates new KeySignature from the parentInput's input stream. The next object in the input stream must be of this type.

Parameters:

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

java.io.IOException

RIFFFormatException

maybeNew

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

Peek into the parentInput's input stream and if the next item is a NIFF key signature, return a new KeySignature. 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