org.jaudiotagger.tag.id3
Class AbstractTagItem

java.lang.Object
  org.jaudiotagger.tag.id3.AbstractTagItem

Direct Known Subclasses:

AbstractTag, AbstractTagFrame, AbstractTagFrameBody

public abstract class AbstractTagItem
extends java.lang.Object

This specifies a series of methods that have to be implemented by all structural subclasses, required to support all copy constructors,iterative methods and so on.

TODO Not sure if this is really correct, if really needed should probably be an interface

Field Summary

static java.util.logging.Logger

logger

Constructor Summary

AbstractTagItem()

AbstractTagItem(AbstractTagItem copyObject)

Method Summary

boolean	equals(java.lang.Object obj) Returns true if this datatype and its body equals the argument and its body.
abstract java.lang.String	getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.
abstract int	getSize() Return size of this item
boolean	isSubsetOf(java.lang.Object obj) Returns true if this datatype is a subset of the argument.
abstract void	read(java.nio.ByteBuffer byteBuffer)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

public static java.util.logging.Logger logger

Constructor Detail

AbstractTagItem

public AbstractTagItem()

AbstractTagItem

public AbstractTagItem(AbstractTagItem copyObject)

Method Detail

getIdentifier

public abstract java.lang.String getIdentifier()

ID string that usually corresponds to the class name, but can be displayed to the user. It is not indended to identify each individual instance.

Returns:

ID string

getSize

public abstract int getSize()

Return size of this item

Returns:

size of this item

read

public abstract void read(java.nio.ByteBuffer byteBuffer)
                   throws TagException

Parameters:

byteBuffer - file to read from

Throws:

TagException - on any exception generated by this library.

isSubsetOf

public boolean isSubsetOf(java.lang.Object obj)

Returns true if this datatype is a subset of the argument. This instance is a subset if it is the same class as the argument.

Parameters:

obj - datatype to determine subset of

Returns:

true if this instance and its entire datatype array list is a subset of the argument.

equals

public boolean equals(java.lang.Object obj)

Returns true if this datatype and its body equals the argument and its body. this datatype is equal if and only if they are the same class

Overrides:

equals in class java.lang.Object

Parameters:

obj - datatype to determine equality of

Returns:

true if this datatype and its body are equal