VorbisStyleComments (Ogg and Vorbis toolkit for Java 0.8 API)

java.lang.Object
- org.gagravarr.ogg.HighLevelOggStreamPacket
- - org.gagravarr.vorbis.VorbisStyleComments

All Implemented Interfaces:

OggAudioTagsHeader, OggStreamPacket

Direct Known Subclasses:

FlacTags, OpusTags, SpeexTags, TheoraComments, VorbisComments
```
public abstract class VorbisStyleComments
extends HighLevelOggStreamPacket
implements OggAudioTagsHeader
```
General class for all Vorbis-style comments/tags, as used by things like Vorbis, Opus and FLAC.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ALBUM`
`static String`	`KEY_ARTIST`
`static String`	`KEY_DATE`
`static String`	`KEY_GENRE`
`static String`	`KEY_TITLE`
`static String`	`KEY_TRACKNUMBER`

Constructor Summary

Constructors
Constructor and Description

VorbisStyleComments()

VorbisStyleComments(OggPacket pkt, int dataBeginsAt)

Constructors
Constructor and Description
`VorbisStyleComments()`
`VorbisStyleComments(OggPacket pkt, int dataBeginsAt)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComment(String tag, String comment)` Adds a comment for a given tag
`String`	`getAlbum()` Returns the (first) Album, or null if no Album tags present.
`Map<String,List<String>>`	`getAllComments()` Returns all the comments
`String`	`getArtist()` Returns the (first) Artist, or null if no Artist tags present.
`List<String>`	`getComments(String tag)` Returns all comments for a given tag, in file order.
`String`	`getDate()` Returns the (first) Date, or null if no Date tags present.
`String`	`getGenre()` Returns the (first) Genre, or null if no Genre tags present.
`protected abstract int`	`getHeaderSize()`
`protected int`	`getInt4(byte[] d, int offset)`
`protected String`	`getSingleComment(String normalisedTag)`
`String`	`getTitle()` Returns the (first) Title, or null if no Title tags present.
`String`	`getTrackNumber()` Returns the (first) track number as a literal string, eg "4" or "09", or null if no track number tags present;
`int`	`getTrackNumberNumeric()` Returns the track number, as converted into an integer, or -1 if not available / not numeric
`String`	`getVendor()`
`protected abstract boolean`	`hasFramingBit()`
`protected static String`	`normaliseTag(String tag)` The tag name is case-insensitive and may consist of ASCII 0x20 through 0x7D, 0x3D (’=’) excluded.
`protected abstract void`	`populateMetadataFooter(OutputStream out)`
`protected abstract void`	`populateMetadataHeader(byte[] data, int packetLength)`
`void`	`removeAllComments()` Removes all comments across all tags
`void`	`removeComments(String tag)` Removes all comments for a given tag.
`void`	`setComments(String tag, List<String> comments)` Removes any existing comments for a given tag, and replaces them with the supplied list
`void`	`setVendor(String vendor)`
`OggPacket`	`write()`

Methods inherited from class org.gagravarr.ogg.HighLevelOggStreamPacket
getData, getOggOverheadSize, getOggPacket, setData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gagravarr.ogg.OggStreamPacket
getData, getOggOverheadSize, setData

- Field Detail
  - KEY_ARTIST
```
public static final String KEY_ARTIST
```
    See Also:
    
    Constant Field Values
  - KEY_ALBUM
```
public static final String KEY_ALBUM
```
    See Also:
    
    Constant Field Values
  - KEY_TITLE
```
public static final String KEY_TITLE
```
    See Also:
    
    Constant Field Values
  - KEY_GENRE
```
public static final String KEY_GENRE
```
    See Also:
    
    Constant Field Values
  - KEY_TRACKNUMBER
```
public static final String KEY_TRACKNUMBER
```
    See Also:
    
    Constant Field Values
  - KEY_DATE
```
public static final String KEY_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VorbisStyleComments
```
public VorbisStyleComments(OggPacket pkt,
                           int dataBeginsAt)
```
  - VorbisStyleComments
```
public VorbisStyleComments()
```
- Method Detail
  - getVendor
```
public String getVendor()
```
    Specified by:
    
    getVendor in interface OggAudioTagsHeader
  - setVendor
```
public void setVendor(String vendor)
```
  - normaliseTag
```
protected static String normaliseTag(String tag)
```
    The tag name is case-insensitive and may consist of ASCII 0x20 through 0x7D, 0x3D (’=’) excluded. ASCII 0x41 through 0x5A inclusive (characters A-Z) is to be considered equivalent to ASCII 0x61 through 0x7A inclusive (characters a-z).
  - getSingleComment
```
protected String getSingleComment(String normalisedTag)
```
  - getArtist
```
public String getArtist()
```
    Returns the (first) Artist, or null if no Artist tags present.
    
    Specified by:
    
    getArtist in interface OggAudioTagsHeader
  - getAlbum
```
public String getAlbum()
```
    Returns the (first) Album, or null if no Album tags present.
    
    Specified by:
    
    getAlbum in interface OggAudioTagsHeader
  - getTitle
```
public String getTitle()
```
    Returns the (first) Title, or null if no Title tags present.
    
    Specified by:
    
    getTitle in interface OggAudioTagsHeader
  - getGenre
```
public String getGenre()
```
    Returns the (first) Genre, or null if no Genre tags present.
    
    Specified by:
    
    getGenre in interface OggAudioTagsHeader
  - getTrackNumber
```
public String getTrackNumber()
```
    Returns the (first) track number as a literal string, eg "4" or "09", or null if no track number tags present;
    
    Specified by:
    
    getTrackNumber in interface OggAudioTagsHeader
  - getTrackNumberNumeric
```
public int getTrackNumberNumeric()
```
    Returns the track number, as converted into an integer, or -1 if not available / not numeric
    
    Specified by:
    
    getTrackNumberNumeric in interface OggAudioTagsHeader
  - getDate
```
public String getDate()
```
    Returns the (first) Date, or null if no Date tags present. Dates are normally stored in ISO8601 date format, i.e. YYYY-MM-DD
    
    Specified by:
    
    getDate in interface OggAudioTagsHeader
  - getComments
```
public List<String> getComments(String tag)
```
    Returns all comments for a given tag, in file order. Will return an empty list for tags which aren't present.
    
    Specified by:
    
    getComments in interface OggAudioTagsHeader
  - removeComments
```
public void removeComments(String tag)
```
    Removes all comments for a given tag.
  - removeAllComments
```
public void removeAllComments()
```
    Removes all comments across all tags
  - addComment
```
public void addComment(String tag,
                       String comment)
```
    Adds a comment for a given tag
  - setComments
```
public void setComments(String tag,
                        List<String> comments)
```
    Removes any existing comments for a given tag, and replaces them with the supplied list
  - getAllComments
```
public Map<String,List<String>> getAllComments()
```
    Returns all the comments
    
    Specified by:
    
    getAllComments in interface OggAudioTagsHeader
  - getHeaderSize
```
protected abstract int getHeaderSize()
```
  - hasFramingBit
```
protected abstract boolean hasFramingBit()
```
  - populateMetadataHeader
```
protected abstract void populateMetadataHeader(byte[] data,
                                               int packetLength)
```
  - populateMetadataFooter
```
protected abstract void populateMetadataFooter(OutputStream out)
```
  - getInt4
```
protected int getInt4(byte[] d,
                      int offset)
```
  - write
```
public OggPacket write()
```
    Specified by:
    
    write in interface OggStreamPacket
    
    Overrides:
    
    write in class HighLevelOggStreamPacket

Class VorbisStyleComments

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.gagravarr.ogg.HighLevelOggStreamPacket

Methods inherited from class java.lang.Object

Methods inherited from interface org.gagravarr.ogg.OggStreamPacket

Field Detail

KEY_ARTIST

KEY_ALBUM

KEY_TITLE

KEY_GENRE

KEY_TRACKNUMBER

KEY_DATE

Constructor Detail

VorbisStyleComments

VorbisStyleComments

Method Detail

getVendor

setVendor

normaliseTag

getSingleComment

getArtist

getAlbum

getTitle

getGenre

getTrackNumber

getTrackNumberNumeric

getDate

getComments

removeComments

removeAllComments

addComment

setComments

getAllComments

getHeaderSize

hasFramingBit

populateMetadataHeader

populateMetadataFooter

getInt4

write