A B C D E F G H I K M N O P R S T U V W X

A

ASXFilter - class org.esau.ptarmigan.impl.filter.ASXFilter.

ASXFilter -- transforms ASX playlist to ptarmigan playlist

ASXFilter() - Constructor for class org.esau.ptarmigan.impl.filter.ASXFilter

B

B4SFilter - class org.esau.ptarmigan.impl.filter.B4SFilter.

B4SFilter -- transforms B4S playlist to ptarmigan playlist

B4SFilter() - Constructor for class org.esau.ptarmigan.impl.filter.B4SFilter

BaseFilter - class org.esau.ptarmigan.impl.filter.BaseFilter.

BaseFilter -- abstract filter with a few services

BaseFilter() - Constructor for class org.esau.ptarmigan.impl.filter.BaseFilter

BinaryFilter - class org.esau.ptarmigan.impl.filter.BinaryFilter.

BinaryFilter -- abstract filter for Binary sources

BinaryFilter() - Constructor for class org.esau.ptarmigan.impl.filter.BinaryFilter

ByteStreamSource - interface org.esau.ptarmigan.impl.ByteStreamSource.

Interface for those filters which feed on InputStreams

C

characters(char[], int, int) - Method in class org.esau.ptarmigan.impl.filter.BaseFilter

Receive notification of character data.

CharacterStreamSource - interface org.esau.ptarmigan.impl.CharacterStreamSource.

Interface for those filters which feed on Readers

clean(String) - Static method in class org.esau.ptarmigan.util.HelperMisc

Removes all chars that do not fit into the categories (isLetterOrDigit, isWhitespace, printable ASCII); does not trim().

cleanAlpha(String) - Static method in class org.esau.ptarmigan.util.HelperMisc

Removes all non-alpha chars

clear() - Method in class org.esau.ptarmigan.util.MultiMap

counter() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

CountingInputStream - class org.esau.ptarmigan.util.CountingInputStream.

Counts the number of bytes that pass through it.

CountingInputStream(InputStream) - Constructor for class org.esau.ptarmigan.util.CountingInputStream

CountingInputStream(InputStream, long) - Constructor for class org.esau.ptarmigan.util.CountingInputStream

D

DEFAULT_INCLUDE_DIGEST - Static variable in interface org.esau.ptarmigan.Generator

by default, do not calculate the digest

DEFAULT_INCLUDE_PLAYLIST_ENTRIES - Static variable in interface org.esau.ptarmigan.Generator

by default, do not include playlist entries in playlist metadata

DEFAULT_PROPERTY_READ_LIMIT - Static variable in interface org.esau.ptarmigan.Generator

by default, read as many as 8192 bytes from the start of a stream to extract tags and determine mime-type.

doParse() - Method in class org.esau.ptarmigan.impl.filter.VorbisFilter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.ID3v2Filter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.MIDIFilter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.RIFFFilter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.WMAFilter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.ID3v1Filter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.MPEGFilter

SAX-Invoked parse of a 'document' from an input stream.

doParse() - Method in class org.esau.ptarmigan.impl.filter.FLACFilter

SAX-Invoked parse of a 'document' from an input stream.

doParse(InputStream) - Method in class org.esau.ptarmigan.impl.filter.SimplePlaylistFilter

Parse a document from a buffered source.

doParsePlaylist(BufferedReader) - Method in class org.esau.ptarmigan.impl.filter.SimplePlaylistFilter

doParsePlaylist(BufferedReader) - Method in class org.esau.ptarmigan.impl.filter.PLSFilter

Parse a document from a buffered source.

doParsePlaylist(BufferedReader) - Method in class org.esau.ptarmigan.impl.filter.M3UFilter

Parse a document from a buffered source.

E

endDocument() - Method in class org.esau.ptarmigan.impl.filter.XMLPlaylistFilter

Filter an end document event (avoids confusion of SAX consumers)

endElement(String, String, String) - Method in class org.esau.ptarmigan.impl.filter.B4SFilter

Filter an end element event.

endElement(String, String, String) - Method in class org.esau.ptarmigan.impl.filter.ASXFilter

Filter an end element event.

epochtoIso8601(long, boolean) - Static method in class org.esau.ptarmigan.util.HelperDate

Create an ISO-8601 date string from the long, which is the number of msecs since the epoch.

extractFrame(boolean, String, byte[]) - Method in class org.esau.ptarmigan.impl.filter.ID3v2Filter

support for readFrames

extractYear(String) - Static method in class org.esau.ptarmigan.util.HelperDate

attempt to extract a valid year from a 2 or 4 digit string Example:

F

fastForward(int) - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

fastForward(int) - Method in class org.esau.ptarmigan.util.CountingInputStream

a substitute for skip, which doesn't seem to want to work correctly on buffered streams

FEATURE_INCLUDE_DIGEST - Static variable in interface org.esau.ptarmigan.Generator

Use with setFeature() to indicate whether or not a /ptarmigan/data/digest member will be created.

FEATURE_INCLUDE_PLAYLIST_ENTRIES - Static variable in interface org.esau.ptarmigan.Generator

Use with setFeature() to indicate whether or not playlist entries will be included.

fileToSystemId(File) - Static method in class org.esau.ptarmigan.util.HelperURL

FLACFilter - class org.esau.ptarmigan.impl.filter.FLACFilter.

Extract metadata from FLAC native tag format

FLACFilter() - Constructor for class org.esau.ptarmigan.impl.filter.FLACFilter

G

Generator - interface org.esau.ptarmigan.Generator.

Generator

GeneratorFactory - class org.esau.ptarmigan.GeneratorFactory.

Generator Factory

GeneratorFactory() - Constructor for class org.esau.ptarmigan.GeneratorFactory

GeneratorImpl - class org.esau.ptarmigan.impl.GeneratorImpl.

GeneratorImpl

GeneratorImpl() - Constructor for class org.esau.ptarmigan.impl.GeneratorImpl

get(String) - Method in class org.esau.ptarmigan.util.MultiMap

getAudioVersion() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getBitRate() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getChannelDesc() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getChannelMode() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getChannels() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getCopyright() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getCount() - Method in class org.esau.ptarmigan.util.CountingInputStream

The number of bytes that have passed through this stream.

getDigest() - Method in class org.esau.ptarmigan.impl.MediaProperties

getDigest(String, Range, File) - Static method in class org.esau.ptarmigan.util.HelperDigest

use the internal File and Range to build an MD5 digest for the audio data

getDigestAlgorithm() - Method in class org.esau.ptarmigan.impl.MediaProperties

getDuration() - Method in class org.esau.ptarmigan.impl.MediaProperties

obtain the duration, in millisecs

getEmphasis() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getFeature(String) - Method in class org.esau.ptarmigan.impl.GeneratorImpl

OVERRIDE Look up the value of a feature.

getFrameLength() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getIncludeEntries() - Method in class org.esau.ptarmigan.impl.filter.PlaylistFilter

getLayer() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getLength() - Method in class org.esau.ptarmigan.util.Range

getLimit() - Method in class org.esau.ptarmigan.util.CountingInputStream

getMediaProperties() - Method in class org.esau.ptarmigan.impl.filter.BaseFilter

getMimeType() - Method in class org.esau.ptarmigan.impl.MediaProperties

getModeExt() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getNullsoftGenre(int) - Static method in class org.esau.ptarmigan.util.HelperID3

return the Nullsoft genre string for the specified numeric code.

getOffset() - Method in class org.esau.ptarmigan.util.Range

getOriginal() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getPadding() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getPrivateBit() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getProperty(String) - Method in class org.esau.ptarmigan.impl.GeneratorImpl

OVERRIDE Look up the value of a property.

getProtection() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

getRange() - Method in class org.esau.ptarmigan.impl.MediaProperties

getRemaining() - Method in class org.esau.ptarmigan.util.CountingInputStream

getSampleRate() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

H

HelperDate - class org.esau.ptarmigan.util.HelperDate.

Some static methods related to use of Dates

HelperDate() - Constructor for class org.esau.ptarmigan.util.HelperDate

HelperDigest - class org.esau.ptarmigan.util.HelperDigest.

Compute checksum/digest for the range of a file

HelperDigest() - Constructor for class org.esau.ptarmigan.util.HelperDigest

HelperID3 - class org.esau.ptarmigan.util.HelperID3.

Common routines for ID3v1 and v2 parsing

HelperID3() - Constructor for class org.esau.ptarmigan.util.HelperID3

HelperIO - class org.esau.ptarmigan.util.HelperIO.

Some static methods of general use

HelperIO() - Constructor for class org.esau.ptarmigan.util.HelperIO

HelperMisc - class org.esau.ptarmigan.util.HelperMisc.

Some static methods of general use

HelperMisc() - Constructor for class org.esau.ptarmigan.util.HelperMisc

HelperURL - class org.esau.ptarmigan.util.HelperURL.

Some static methods for manipulation of URLs

HelperURL() - Constructor for class org.esau.ptarmigan.util.HelperURL

I

ID3v1Filter - class org.esau.ptarmigan.impl.filter.ID3v1Filter.

Extract metadata from an ID3v1 tag

ID3v1Filter() - Constructor for class org.esau.ptarmigan.impl.filter.ID3v1Filter

ID3v2Filter - class org.esau.ptarmigan.impl.filter.ID3v2Filter.

Extract metadata from ID3v2 native tag format

ID3v2Filter() - Constructor for class org.esau.ptarmigan.impl.filter.ID3v2Filter

increaseOffset(long) - Method in class org.esau.ptarmigan.util.Range

BOTH increase the offset AND shrink the range length by the specified amount.

initHeader(byte[], int) - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

Try to identify a frame header in the specified buffer at the specified offset.

isLengthValid() - Method in class org.esau.ptarmigan.util.Range

isMatch(String) - Method in class org.esau.ptarmigan.impl.filter.PlaylistFilter

can this parser handle the text file?

isMatch(String) - Method in class org.esau.ptarmigan.impl.filter.B4SFilter

is the root element of the xml file indicate it's WinampXML? Note: do B4S files have namespaces?

isMatch(String) - Method in class org.esau.ptarmigan.impl.filter.PLSFilter

does the specified stream contain a marker for the tag?

isMatch(String) - Method in class org.esau.ptarmigan.impl.filter.ASXFilter

is the text file an XML file with that dodgy ASX marker? Note: ASX files may not start with "isMatch(String) - Method in class org.esau.ptarmigan.impl.filter.M3UFilter

does the specified stream contain a marker for the tag?

isOffsetValid() - Method in class org.esau.ptarmigan.util.Range

isValid() - Method in class org.esau.ptarmigan.util.Range

K

keySet() - Method in class org.esau.ptarmigan.util.MultiMap

M

M3UFilter - class org.esau.ptarmigan.impl.filter.M3UFilter.

M3UFilter -- transforms M3U playlist to ptarmigan playlist

M3UFilter() - Constructor for class org.esau.ptarmigan.impl.filter.M3UFilter

maybeDecode(String) - Static method in class org.esau.ptarmigan.util.HelperURL

If the specified string contains only ASCII characters, then try to escape any UTF-8 characters present.

MediaProperties - class org.esau.ptarmigan.impl.MediaProperties.

MediaProperties

MediaProperties() - Constructor for class org.esau.ptarmigan.impl.MediaProperties

MIDIFilter - class org.esau.ptarmigan.impl.filter.MIDIFilter.

Extract metadata from MIDI native tag format.

MIDIFilter() - Constructor for class org.esau.ptarmigan.impl.filter.MIDIFilter

MPEGFilter - class org.esau.ptarmigan.impl.filter.MPEGFilter.

Extract metadata from MPEG frame data, if present

MPEGFilter() - Constructor for class org.esau.ptarmigan.impl.filter.MPEGFilter

MPEGFrameHeader - class org.esau.ptarmigan.impl.MPEGFrameHeader.

MPEG Frame Header

MPEGFrameHeader() - Constructor for class org.esau.ptarmigan.impl.MPEGFrameHeader

ctor

MPEGFrameHeader(MPEGFrameHeader) - Constructor for class org.esau.ptarmigan.impl.MPEGFrameHeader

copy ctor

MultiMap - class org.esau.ptarmigan.util.MultiMap.

A map where more than one value can be associated with a key.

MultiMap() - Constructor for class org.esau.ptarmigan.util.MultiMap

N

newInstance() - Static method in class org.esau.ptarmigan.GeneratorFactory

O

org.esau.ptarmigan - package org.esau.ptarmigan

Ptarmigan's factory and interface.

org.esau.ptarmigan.impl - package org.esau.ptarmigan.impl

The default implementation.

org.esau.ptarmigan.impl.filter - package org.esau.ptarmigan.impl.filter

The parser library for the default implementation.

org.esau.ptarmigan.impl.test - package org.esau.ptarmigan.impl.test

The test harness.

org.esau.ptarmigan.util - package org.esau.ptarmigan.util

Various utility classes to support generation and parsing.

P

parse(InputSource) - Method in class org.esau.ptarmigan.impl.GeneratorImpl

OVERRIDE SAX-invoked parse If it's a file, attempt to parse the ID3v1 tag at the end of the file.

parse(InputSource) - Method in class org.esau.ptarmigan.impl.filter.BaseFilter

SAX-Invoked parse of a 'document' from an input stream.

parseInt(String, int) - Static method in class org.esau.ptarmigan.util.HelperMisc

a safe integer parser

PlaylistFilter - class org.esau.ptarmigan.impl.filter.PlaylistFilter.

PlaylistFilter -- transforms XML playlist to ptarmigan playlist

PlaylistFilter() - Constructor for class org.esau.ptarmigan.impl.filter.PlaylistFilter

PLSFilter - class org.esau.ptarmigan.impl.filter.PLSFilter.

PLSFilter -- transforms PLS playlist to ptarmigan playlist

PLSFilter() - Constructor for class org.esau.ptarmigan.impl.filter.PLSFilter

PROPERTY_READ_LIMIT - Static variable in interface org.esau.ptarmigan.Generator

Use with setProperty() to indicate the limit on the number of bytes to be read from the start of a stream to extract tags and determine mime-type.

PtarmiganTest - class org.esau.ptarmigan.impl.test.PtarmiganTest.

Test Suite for the default implementation of Ptarmigan

PtarmiganTest(String) - Constructor for class org.esau.ptarmigan.impl.test.PtarmiganTest

put(String, String) - Method in class org.esau.ptarmigan.util.MultiMap

add the following key=value pair

R

RandomAccessFileSource - interface org.esau.ptarmigan.impl.RandomAccessFileSource.

Interface for those filters which feed on Files, either for random access or just to extract information from the filename itself.

Range - class org.esau.ptarmigan.util.Range.

Range

Range() - Constructor for class org.esau.ptarmigan.util.Range

Range(long, long) - Constructor for class org.esau.ptarmigan.util.Range

read() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

read(byte[]) - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

read(byte[], int, int) - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readC() - Method in class org.esau.ptarmigan.util.CountingInputStream

readC(byte[]) - Method in class org.esau.ptarmigan.util.CountingInputStream

readC(byte[], int, int) - Method in class org.esau.ptarmigan.util.CountingInputStream

readCharBE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readCharLE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readInt16BE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readInt16LE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readInt24BE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readInt24LE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readInt32BE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

readInt32LE() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

reduceLength(long) - Method in class org.esau.ptarmigan.util.Range

remaining() - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

resetCount() - Method in class org.esau.ptarmigan.util.CountingInputStream

Start the count at zero

resetData() - Method in interface org.esau.ptarmigan.Generator

Resets data members for Generator reuse.

resetData() - Method in class org.esau.ptarmigan.impl.MPEGFrameHeader

resetData() - Method in class org.esau.ptarmigan.impl.GeneratorImpl

Reset data members for reuse

resetData() - Method in class org.esau.ptarmigan.impl.MediaProperties

resetData() - Method in class org.esau.ptarmigan.impl.filter.PlaylistFilter

rewind(int) - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

rewind(int) - Method in class org.esau.ptarmigan.util.CountingInputStream

reposition the stream from the last mark point (in case we read too far)

RIFFFilter - class org.esau.ptarmigan.impl.filter.RIFFFilter.

Extract metadata from a Resource Interchange File Format (RIFF) native tag format.

RIFFFilter() - Constructor for class org.esau.ptarmigan.impl.filter.RIFFFilter

S

safeClose(InputStream) - Static method in class org.esau.ptarmigan.util.HelperIO

helper for closing files

safeClose(OutputStream) - Static method in class org.esau.ptarmigan.util.HelperIO

helper for closing files

safeClose(RandomAccessFile) - Static method in class org.esau.ptarmigan.util.HelperIO

helper for closing files

safeClose(Reader) - Static method in class org.esau.ptarmigan.util.HelperIO

helper for closing files

safeClose(Writer) - Static method in class org.esau.ptarmigan.util.HelperIO

helper for closing files

setBaseDir(File) - Method in class org.esau.ptarmigan.impl.filter.PlaylistFilter

provide a directory by which relative paths will be resolved

setContentHandler(ContentHandler) - Method in class org.esau.ptarmigan.impl.GeneratorImpl

OVERRIDE Set the content event handler.

setCounterLimit(int) - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

setDigest(String) - Method in class org.esau.ptarmigan.impl.MediaProperties

setDigestAlgorithm(String) - Method in class org.esau.ptarmigan.impl.MediaProperties

setDuration(long) - Method in class org.esau.ptarmigan.impl.MediaProperties

assign the duration, in millisecs

setFeature(String, boolean) - Method in class org.esau.ptarmigan.impl.GeneratorImpl

OVERRIDE Set the value of a feature.

setIncludeEntries(boolean) - Method in class org.esau.ptarmigan.impl.filter.PlaylistFilter

setLength(long) - Method in class org.esau.ptarmigan.util.Range

setLimit(long) - Method in class org.esau.ptarmigan.util.CountingInputStream

setMediaProperties(MediaProperties) - Method in class org.esau.ptarmigan.impl.filter.BaseFilter

setMimeType(String) - Method in class org.esau.ptarmigan.impl.MediaProperties

setOffset(long) - Method in class org.esau.ptarmigan.util.Range

setProperty(String, Object) - Method in class org.esau.ptarmigan.impl.GeneratorImpl

OVERRIDE Set the value of a property.

setRange(Range) - Method in class org.esau.ptarmigan.impl.MediaProperties

SimplePlaylistFilter - class org.esau.ptarmigan.impl.filter.SimplePlaylistFilter.

SimplePlaylistFilter -- base class for M3U and PLS filters

SimplePlaylistFilter() - Constructor for class org.esau.ptarmigan.impl.filter.SimplePlaylistFilter

skip(long) - Method in class org.esau.ptarmigan.impl.filter.BinaryFilter

skipC(long) - Method in class org.esau.ptarmigan.util.CountingInputStream

startDocument() - Method in class org.esau.ptarmigan.impl.filter.XMLPlaylistFilter

Filter a start document event (avoids confusion of SAX consumers)

startElement(String, String, String, Attributes) - Method in class org.esau.ptarmigan.impl.filter.B4SFilter

Filter a start element event.

startElement(String, String, String, Attributes) - Method in class org.esau.ptarmigan.impl.filter.ASXFilter

Filter a start element event.

startsWith(byte[], int, int, byte[]) - Static method in class org.esau.ptarmigan.util.HelperMisc

is the needle the first thing in the haystack?

suite() - Static method in class org.esau.ptarmigan.impl.test.PtarmiganTest

systemIdToFile(String) - Static method in class org.esau.ptarmigan.util.HelperURL

T

testAll() - Method in class org.esau.ptarmigan.impl.test.PtarmiganTest

run generator against all files specified in property "test.input.dir"

toString() - Method in class org.esau.ptarmigan.impl.MediaProperties

toString() - Method in class org.esau.ptarmigan.util.Range

toURL(File) - Static method in class org.esau.ptarmigan.util.HelperURL

produce a UTF-8 encoded URL from a File source

toURL(File, String) - Static method in class org.esau.ptarmigan.util.HelperURL

produce a UTF-8 encoded URL from various formats.

U

URLToFile(String) - Static method in class org.esau.ptarmigan.util.HelperURL

extract a File object from a UTF-8-encoded URL if the URL has a file protocol.

URLToFile(URL) - Static method in class org.esau.ptarmigan.util.HelperURL

extract a File object from a UTF-8-encoded URL if the URL has a file protocol requires URIUtil from Jakarta Common's HttpClient NOTE: if truncation is occurring, it's probably because the URL wasn't encoded in UTF-8.

V

VorbisCommentFilter - class org.esau.ptarmigan.impl.filter.VorbisCommentFilter.

Extract metadata from an OGG Vorbis native tag format Following the three header packets, all packets in a Vorbis I stream are audio.

VorbisCommentFilter() - Constructor for class org.esau.ptarmigan.impl.filter.VorbisCommentFilter

VorbisFilter - class org.esau.ptarmigan.impl.filter.VorbisFilter.

Extract metadata from an OGG Vorbis native tag format Following the three header packets, all packets in a Vorbis I stream are audio.

VorbisFilter() - Constructor for class org.esau.ptarmigan.impl.filter.VorbisFilter

W

WMAFilter - class org.esau.ptarmigan.impl.filter.WMAFilter.

Extract metadata from WMA native tag format

WMAFilter() - Constructor for class org.esau.ptarmigan.impl.filter.WMAFilter

X

XMLPlaylistFilter - class org.esau.ptarmigan.impl.filter.XMLPlaylistFilter.

XMLPlaylistFilter -- abstract base class for XML playlists

XMLPlaylistFilter() - Constructor for class org.esau.ptarmigan.impl.filter.XMLPlaylistFilter

A B C D E F G H I K M N O P R S T U V W X