TiffDataType
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Comparable
public abstract class TiffDataType implements Comparable<TiffDataType>
The TIFF data type.
Constructors
| Constructor | Description |
|---|---|
| TiffDataType() |
Methods
| Method | Description |
|---|---|
| getElementSize() | Gets the element size in bytes. |
| getDataSize() | Gets the tag value size. |
| getCount() | Gets the count of elements. |
| getId() | Gets tag id as number. |
| getTagId() | Gets the tag id. |
| getTagType() | Gets the tag type. |
| getAlignedDataSize(byte sizeOfTagValue) | Gets the data size aligned in 4-byte (int) or 8-byte (long) boundary. |
| getAdditionalDataSize(byte sizeOfTagValue) | Gets the additional tag value size in bytes (in case the tag can not fit the whole tag value). |
| getValue() | Gets the value this data type contains. |
| setValue(Object value) | Sets the value this data type contains. |
| isValid() | Gets a value indicating whether tag data is valid. |
| readTag(TiffStreamReader dataStream, long position) | Reads the tag data. |
| compareTo(TiffDataType obj) | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |
| hashCode() | |
| equals(Object obj) | |
| deepClone() | Performs a deep clone of this instance. |
| writeTag(TiffStreamWriter dataStream, long additionalDataOffset) | Writes the tag data. |
| writeAdditionalData(TiffStreamWriter dataStream) | Writes the additional tag data. |
| toString() | Returns a System.String that represents this instance. |
TiffDataType()
public TiffDataType()
getElementSize()
public byte getElementSize()
Gets the element size in bytes.
Returns: byte - the element size in bytes.
getDataSize()
public long getDataSize()
Gets the tag value size.
Returns: long - the tag value size.
getCount()
public abstract long getCount()
Gets the count of elements.
Value: The count of elements.
Returns: long - the count of elements.
getId()
public final int getId()
Gets tag id as number.
Returns: int - tag id as number.
getTagId()
public int getTagId()
Gets the tag id.
Returns: int - The tag id.
getTagType()
public abstract int getTagType()
Gets the tag type.
Returns: int - The tag type.
getAlignedDataSize(byte sizeOfTagValue)
public final long getAlignedDataSize(byte sizeOfTagValue)
Gets the data size aligned in 4-byte (int) or 8-byte (long) boundary.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sizeOfTagValue | byte | Size of tag value. |
Returns: long - The aligned data size in bytes.
getAdditionalDataSize(byte sizeOfTagValue)
public long getAdditionalDataSize(byte sizeOfTagValue)
Gets the additional tag value size in bytes (in case the tag can not fit the whole tag value).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sizeOfTagValue | byte | Size of tag value: 4 or 8 for BigTiff. |
Returns: long - The additional data size in bytes.
getValue()
public abstract Object getValue()
Gets the value this data type contains.
Returns: java.lang.Object - The value.
setValue(Object value)
public abstract void setValue(Object value)
Sets the value this data type contains.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Object | The value. |
isValid()
public boolean isValid()
Gets a value indicating whether tag data is valid. The valid tag contains data which may be preserved. The invalid tag cannot be stored.
Returns:
boolean - true if tag data is valid; otherwise, false.
readTag(TiffStreamReader dataStream, long position)
public static TiffDataType readTag(TiffStreamReader dataStream, long position)
Reads the tag data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dataStream | TiffStreamReader | The data stream. |
| position | long | The tag position. |
Returns: TiffDataType - The read tag.
compareTo(TiffDataType obj)
public int compareTo(TiffDataType obj)
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | TiffDataType | An object to compare with this instance. |
Returns:
int - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance is less than obj. Zero This instance is equal to obj. Greater than zero This instance is greater than obj.
hashCode()
public int hashCode()
Returns: int
equals(Object obj)
public boolean equals(Object obj)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object |
Returns: boolean
deepClone()
public TiffDataType deepClone()
Performs a deep clone of this instance.
Returns: TiffDataType - A deep clone of the current instance.
writeTag(TiffStreamWriter dataStream, long additionalDataOffset)
public void writeTag(TiffStreamWriter dataStream, long additionalDataOffset)
Writes the tag data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dataStream | TiffStreamWriter | The data stream. |
| additionalDataOffset | long | The offset to write additional data to. |
writeAdditionalData(TiffStreamWriter dataStream)
public abstract long writeAdditionalData(TiffStreamWriter dataStream)
Writes the additional tag data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dataStream | TiffStreamWriter | The data stream. |
Returns: long - The actual bytes written.
toString()
public String toString()
Returns a System.String that represents this instance.
Returns:
java.lang.String - A System.String that represents this instance.