|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jaudiotagger.tag.vorbiscomment.VorbisCommentTagField
public class VorbisCommentTagField
This class represents the name and content of a tag entry in ogg-files.
Constructor Summary | |
---|---|
VorbisCommentTagField(byte[] raw)
Creates an instance. |
|
VorbisCommentTagField(java.lang.String fieldId,
java.lang.String fieldContent)
Creates an instance. |
Method Summary | |
---|---|
void |
copyContent(TagField field)
This method copies the data of the given field to the current data. |
java.lang.String |
getContent()
Returns the content of the field. |
java.lang.String |
getEncoding()
Returns the current used charset encoding. |
java.lang.String |
getId()
Returns the Id of the represented tag field. This value should uniquely identify a kind of tag data, like title. |
byte[] |
getRawContent()
This method delivers the binary representation of the fields data in order to be directly written to the file. |
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 . |
void |
isBinary(boolean b)
This method will set the field to represent binary data. Some implementations may support conversions. As of now (Octobre 2005) there is no implementation really using this method to perform useful operations. |
boolean |
isCommon()
Identifies a field to be of common use. Some software may differ between common and not common fields. |
boolean |
isEmpty()
Determines whether the content of the field is empty. |
void |
setContent(java.lang.String s)
Sets the content of the field. |
void |
setEncoding(java.lang.String s)
Sets the charset encoding used by the field. |
java.lang.String |
toString()
This method returns a human readable description of the fields contents. For text fields it should be the text itself. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public VorbisCommentTagField(byte[] raw) throws java.io.UnsupportedEncodingException
raw
- Raw byte data of the tagfield.
java.io.UnsupportedEncodingException
- If the data doesn't conform "UTF-8" specification.public VorbisCommentTagField(java.lang.String fieldId, java.lang.String fieldContent)
fieldId
- ID (name) of the field.fieldContent
- Content of the field.Method Detail |
---|
public void copyContent(TagField field)
TagField
copyContent
in interface TagField
field
- The field containing the data to be taken.TagField.copyContent(TagField)
public java.lang.String getContent()
TagTextField
getContent
in interface TagTextField
TagTextField.getContent()
public java.lang.String getEncoding()
TagTextField
getEncoding
in interface TagTextField
TagTextField.getEncoding()
public java.lang.String getId()
TagField
AbstractTag
will use the "id" to summarize multiple
fields.
getId
in interface TagField
TagField.getId()
public byte[] getRawContent() throws java.io.UnsupportedEncodingException
TagField
getRawContent
in interface TagField
java.io.UnsupportedEncodingException
- Most tag data represents text. In some cases the underlying
implementation will need to convert the text data in java to
a specific charset encoding. In these cases an
UnsupportedEncodingException
may occur.TagField.getRawContent()
public boolean isBinary()
TagField
false
.
isBinary
in interface TagField
true
if field represents binary data (not human
readable).TagField.isBinary()
public void isBinary(boolean b)
TagField
isBinary
in interface TagField
b
- true
, if the field contains binary data.TagField.isBinary(boolean)
public boolean isCommon()
TagField
isCommon
in interface TagField
true
if the field is of common use.TagField.isCommon()
public boolean isEmpty()
TagField
isEmpty
in interface TagField
true
if no data is stored (or empty String).TagField.isEmpty()
public void setContent(java.lang.String s)
TagTextField
setContent
in interface TagTextField
s
- fields content.TagTextField.setContent(String)
public void setEncoding(java.lang.String s)
TagTextField
setEncoding
in interface TagTextField
s
- charset.TagTextField.setEncoding(String)
public java.lang.String toString()
TagField
toString
in interface TagField
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |