ID3v2Frame (mp3agic 0.9.1 API)

java.lang.Object
- com.mpatric.mp3agic.ID3v2Frame

Direct Known Subclasses:

ID3v24Frame, ID3v2ObseleteFrame
```
public class ID3v2Frame
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`compression`
`private static int`	`COMPRESSION_BIT`
`protected byte[]`	`data`
`private static int`	`DATA_LENGTH_INDICATOR_BIT`
`protected static int`	`DATA_LENGTH_OFFSET`
`protected int`	`dataLength`
`private boolean`	`dataLengthIndicator`
`private boolean`	`encryption`
`private static int`	`ENCRYPTION_BIT`
`private static int`	`FLAGS1_OFFSET`
`private static int`	`FLAGS2_OFFSET`
`private boolean`	`group`
`private static int`	`GROUP_BIT`
`private static int`	`HEADER_LENGTH`
`protected String`	`id`
`private static int`	`ID_LENGTH`
`private static int`	`ID_OFFSET`
`private static int`	`PRESERVE_FILE_BIT`
`private static int`	`PRESERVE_TAG_BIT`
`private boolean`	`preserveFile`
`private boolean`	`preserveTag`
`private static int`	`READ_ONLY_BIT`
`private boolean`	`readOnly`
`private boolean`	`unsynchronisation`
`private static int`	`UNSYNCHRONISATION_BIT`

Constructor Summary

Constructors
Constructor and Description

ID3v2Frame(byte[] buffer, int offset)

ID3v2Frame(String id, byte[] data)

Constructors
Constructor and Description
`ID3v2Frame(byte[] buffer, int offset)`
`ID3v2Frame(String id, byte[] data)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`byte[]`	`getData()`
`int`	`getDataLength()`
`String`	`getId()`
`int`	`getLength()`
`boolean`	`hasCompression()`
`boolean`	`hasDataLengthIndicator()`
`boolean`	`hasEncryption()`
`boolean`	`hasGroup()`
`int`	`hashCode()`
`boolean`	`hasPreserveFile()`
`boolean`	`hasPreserveTag()`
`boolean`	`hasUnsynchronisation()`
`boolean`	`isReadOnly()`
`protected byte[]`	`packDataLength()`
`private byte[]`	`packFlags()`
`void`	`packFrame(byte[] bytes, int offset)`
`private void`	`packHeader(byte[] bytes, int i)`
`protected void`	`sanityCheckUnpackedHeader()`
`void`	`setData(byte[] data)`
`byte[]`	`toBytes()`
`void`	`toBytes(byte[] bytes, int offset)`
`protected void`	`unpackDataLength(byte[] buffer, int offset)`
`private void`	`unpackFlags(byte[] buffer, int offset)`
`protected void`	`unpackFrame(byte[] buffer, int offset)`
`protected int`	`unpackHeader(byte[] buffer, int offset)`

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

Field Detail

HEADER_LENGTH
```
private static final int HEADER_LENGTH
```
See Also:

Constant Field Values

ID_OFFSET
```
private static final int ID_OFFSET
```
See Also:

Constant Field Values

ID_LENGTH
```
private static final int ID_LENGTH
```
See Also:

Constant Field Values

DATA_LENGTH_OFFSET
```
protected static final int DATA_LENGTH_OFFSET
```
See Also:

Constant Field Values

FLAGS1_OFFSET
```
private static final int FLAGS1_OFFSET
```
See Also:

Constant Field Values

FLAGS2_OFFSET
```
private static final int FLAGS2_OFFSET
```
See Also:

Constant Field Values

PRESERVE_TAG_BIT
```
private static final int PRESERVE_TAG_BIT
```
See Also:

Constant Field Values

PRESERVE_FILE_BIT
```
private static final int PRESERVE_FILE_BIT
```
See Also:

Constant Field Values

READ_ONLY_BIT
```
private static final int READ_ONLY_BIT
```
See Also:

Constant Field Values

GROUP_BIT
```
private static final int GROUP_BIT
```
See Also:

Constant Field Values

COMPRESSION_BIT
```
private static final int COMPRESSION_BIT
```
See Also:

Constant Field Values

ENCRYPTION_BIT
```
private static final int ENCRYPTION_BIT
```
See Also:

Constant Field Values

UNSYNCHRONISATION_BIT
```
private static final int UNSYNCHRONISATION_BIT
```
See Also:

Constant Field Values

DATA_LENGTH_INDICATOR_BIT
```
private static final int DATA_LENGTH_INDICATOR_BIT
```
See Also:

Constant Field Values

id
```
protected String id
```

dataLength
```
protected int dataLength
```

data
```
protected byte[] data
```

preserveTag
```
private boolean preserveTag
```

preserveFile
```
private boolean preserveFile
```

readOnly
```
private boolean readOnly
```

group
```
private boolean group
```

compression
```
private boolean compression
```

encryption
```
private boolean encryption
```

unsynchronisation
```
private boolean unsynchronisation
```

dataLengthIndicator
```
private boolean dataLengthIndicator
```

Constructor Detail

ID3v2Frame

public ID3v2Frame(byte[] buffer,
                  int offset)
           throws InvalidDataException

Throws:: InvalidDataException

ID3v2Frame

public ID3v2Frame(String id,
                  byte[] data)

Method Detail

unpackFrame

protected final void unpackFrame(byte[] buffer,
                                 int offset)
                          throws InvalidDataException

Throws:: InvalidDataException

unpackHeader

protected int unpackHeader(byte[] buffer,
                           int offset)

unpackDataLength

protected void unpackDataLength(byte[] buffer,
                                int offset)

unpackFlags

private void unpackFlags(byte[] buffer,
                         int offset)

sanityCheckUnpackedHeader

protected void sanityCheckUnpackedHeader()
                                  throws InvalidDataException

Throws:: InvalidDataException

toBytes

public byte[] toBytes()
               throws NotSupportedException

Throws:: NotSupportedException

toBytes

public void toBytes(byte[] bytes,
                    int offset)
             throws NotSupportedException

Throws:: NotSupportedException

packFrame

public void packFrame(byte[] bytes,
                      int offset)
               throws NotSupportedException

Throws:: NotSupportedException

packHeader

private void packHeader(byte[] bytes,
                        int i)

packDataLength
```
protected byte[] packDataLength()
```

packFlags
```
private byte[] packFlags()
```

getId
```
public String getId()
```

getDataLength
```
public int getDataLength()
```

getLength
```
public int getLength()
```

getData
```
public byte[] getData()
```

setData
```
public void setData(byte[] data)
```

hasDataLengthIndicator

public boolean hasDataLengthIndicator()

hasCompression
```
public boolean hasCompression()
```

hasEncryption
```
public boolean hasEncryption()
```

hasGroup
```
public boolean hasGroup()
```

hasPreserveFile
```
public boolean hasPreserveFile()
```

hasPreserveTag
```
public boolean hasPreserveTag()
```

isReadOnly
```
public boolean isReadOnly()
```

hasUnsynchronisation
```
public boolean hasUnsynchronisation()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

Class ID3v2Frame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEADER_LENGTH

ID_OFFSET

ID_LENGTH

DATA_LENGTH_OFFSET

FLAGS1_OFFSET

FLAGS2_OFFSET

PRESERVE_TAG_BIT

PRESERVE_FILE_BIT

READ_ONLY_BIT

GROUP_BIT

COMPRESSION_BIT

ENCRYPTION_BIT

UNSYNCHRONISATION_BIT

DATA_LENGTH_INDICATOR_BIT

id

dataLength

data

preserveTag

preserveFile

readOnly

group

compression

encryption

unsynchronisation

dataLengthIndicator

Constructor Detail

ID3v2Frame

ID3v2Frame

Method Detail

unpackFrame

unpackHeader

unpackDataLength

unpackFlags

sanityCheckUnpackedHeader

toBytes

toBytes

packFrame

packHeader

packDataLength

packFlags

getId

getDataLength

getLength

getData

setData

hasDataLengthIndicator

hasCompression

hasEncryption

hasGroup

hasPreserveFile

hasPreserveTag

isReadOnly

hasUnsynchronisation

hashCode

equals