|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jaudiotagger.tag.id3.AbstractTagItem
org.jaudiotagger.tag.id3.AbstractTagFrame
org.jaudiotagger.tag.id3.AbstractID3v2Frame
org.jaudiotagger.tag.id3.ID3v23Frame
public class ID3v23Frame
Represents an ID3v2.3 frame.
Nested Class Summary | |
---|---|
(package private) class |
ID3v23Frame.EncodingFlags
This represents a frame headers Encoding Flags |
(package private) class |
ID3v23Frame.StatusFlags
This represents a frame headers Status Flags Make adjustments if necessary based on frame type and specification. |
Field Summary | |
---|---|
private int |
encryptionMethod
If the frame is encrypted then the encryption method is stored in this byte |
protected static int |
FRAME_COMPRESSION_UNCOMPRESSED_SIZE
|
protected static int |
FRAME_ENCRYPTION_INDICATOR_SIZE
|
protected static int |
FRAME_FLAGS_SIZE
|
protected static int |
FRAME_GROUPING_INDICATOR_SIZE
|
protected static int |
FRAME_HEADER_SIZE
|
protected static int |
FRAME_ID_SIZE
|
protected static int |
FRAME_SIZE_SIZE
|
private int |
groupIdentifier
If the frame belongs in a group with other frames then the group identifier byte is stored |
private static java.util.regex.Pattern |
validFrameIdentifier
|
Fields inherited from class org.jaudiotagger.tag.id3.AbstractID3v2Frame |
---|
encodingFlags, frameSize, identifier, statusFlags, TYPE_FRAME, TYPE_FRAME_SIZE, UNSUPPORTED_ID |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrame |
---|
frameBody |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem |
---|
logger |
Constructor Summary | |
---|---|
ID3v23Frame()
Creates a new ID3v23 Frame |
|
ID3v23Frame(AbstractID3v2Frame frame)
Creates a new ID3v23Frame based on another frame of a different version. |
|
ID3v23Frame(java.nio.ByteBuffer byteBuffer)
Deprecated. use ID3v23Frame(ByteBuffer,String) instead |
|
ID3v23Frame(java.nio.ByteBuffer byteBuffer,
java.lang.String loggingFilename)
Creates a new ID3v23Frame dataType by reading from byteBuffer. |
|
ID3v23Frame(ID3v23Frame frame)
Copy Constructor Creates a new v23 frame based on another v23 frame |
|
ID3v23Frame(java.lang.String identifier)
Creates a new ID3v23 Frame of type identifier. |
Method Summary | |
---|---|
void |
createStructure()
Return String Representation of body |
boolean |
equals(java.lang.Object obj)
Compare for equality To be deemed equal obj must be a IDv23Frame with the same identifier and the same flags. |
AbstractID3v2Frame.EncodingFlags |
getEncodingFlags()
|
int |
getEncryptionMethod()
|
protected int |
getFrameHeaderSize()
|
protected int |
getFrameIdSize()
|
protected int |
getFrameSizeSize()
|
int |
getGroupIdentifier()
|
int |
getSize()
Return size of frame |
AbstractID3v2Frame.StatusFlags |
getStatusFlags()
|
boolean |
isBinary()
Determines whether the represented field contains (is made up of) binary data, instead of text data. Software can identify fields to be displayed because they are human readable if this method returns false . |
boolean |
isCommon()
Identifies a field to be of common use. Some software may differ between common and not common fields. |
boolean |
isValidID3v2FrameIdentifier(java.lang.String identifier)
Does the frame identifier meet the syntax for a idv3v2 frame identifier. |
void |
read(java.nio.ByteBuffer byteBuffer)
Read the frame from a byteBuffer |
void |
setEncoding(java.lang.String encoding)
Sets the charset encoding used by the field. |
void |
write(java.io.ByteArrayOutputStream tagBuffer)
Write the frame to bufferOutputStream |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractID3v2Frame |
---|
copyContent, getContent, getEncoding, getId, getIdentifier, getLoggingFilename, getRawContent, isBinary, isEmpty, isPadding, readBody, readBody, readEncryptedBody, readIdentifier, setContent, setLoggingFilename |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrame |
---|
getBody, isSubsetOf, setBody |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jaudiotagger.tag.TagField |
---|
toString |
Field Detail |
---|
private static java.util.regex.Pattern validFrameIdentifier
protected static final int FRAME_ID_SIZE
protected static final int FRAME_FLAGS_SIZE
protected static final int FRAME_SIZE_SIZE
protected static final int FRAME_COMPRESSION_UNCOMPRESSED_SIZE
protected static final int FRAME_ENCRYPTION_INDICATOR_SIZE
protected static final int FRAME_GROUPING_INDICATOR_SIZE
protected static final int FRAME_HEADER_SIZE
private int encryptionMethod
private int groupIdentifier
Constructor Detail |
---|
public ID3v23Frame()
public ID3v23Frame(java.lang.String identifier)
An empty body of the correct type will be automatically created. This constructor should be used when wish to create a new frame from scratch using user data.
identifier
- public ID3v23Frame(ID3v23Frame frame)
frame
- public ID3v23Frame(AbstractID3v2Frame frame) throws InvalidFrameException
frame
-
InvalidFrameException
public ID3v23Frame(java.nio.ByteBuffer byteBuffer, java.lang.String loggingFilename) throws InvalidFrameException, InvalidDataTypeException
byteBuffer
- to read fromloggingFilename
-
InvalidFrameException
InvalidDataTypeException
public ID3v23Frame(java.nio.ByteBuffer byteBuffer) throws InvalidFrameException, InvalidDataTypeException
ID3v23Frame(ByteBuffer,String)
instead
byteBuffer
- to read from
InvalidFrameException
InvalidDataTypeException
Method Detail |
---|
protected int getFrameIdSize()
getFrameIdSize
in class AbstractID3v2Frame
protected int getFrameSizeSize()
getFrameSizeSize
in class AbstractID3v2Frame
protected int getFrameHeaderSize()
getFrameHeaderSize
in class AbstractID3v2Frame
public int getSize()
getSize
in class AbstractTagItem
public boolean equals(java.lang.Object obj)
equals
in class AbstractID3v2Frame
obj
-
public void read(java.nio.ByteBuffer byteBuffer) throws InvalidFrameException, InvalidDataTypeException
read
in class AbstractTagItem
byteBuffer
- buffer to read from
InvalidFrameException
InvalidDataTypeException
public void write(java.io.ByteArrayOutputStream tagBuffer)
write
in class AbstractID3v2Frame
java.io.IOException
public AbstractID3v2Frame.StatusFlags getStatusFlags()
getStatusFlags
in class AbstractID3v2Frame
public AbstractID3v2Frame.EncodingFlags getEncodingFlags()
getEncodingFlags
in class AbstractID3v2Frame
public int getEncryptionMethod()
public int getGroupIdentifier()
public boolean isValidID3v2FrameIdentifier(java.lang.String identifier)
identifier
- to be checked
public void createStructure()
createStructure
in class AbstractID3v2Frame
public boolean isCommon()
TagField
public boolean isBinary()
TagField
false
.
public void setEncoding(java.lang.String encoding)
encoding
- charset.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |