ExifTagInfo

java.lang.Object
- ly.img.android.sdk.exif.ExifTagInfo

```
public class ExifTagInfo
extends java.lang.Object
```
This class stores information of an EXIF tag. For more information about defined EXIF tags, please read the Jeita EXIF 2.2 standard. Tags should be instantiated using Exify.buildTag(ly.img.android.sdk.exif.Exify.TAG, java.lang.Object).

See Also:

Exify

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`TYPE_ASCII` The ASCII type in the EXIF standard.
`static short`	`TYPE_LONG` The SLONG type in the EXIF standard.
`static short`	`TYPE_RATIONAL` The SRATIONAL type of EXIF standard.
`static short`	`TYPE_UNDEFINED` The UNDEFINED type in the EXIF standard.
`static short`	`TYPE_UNSIGNED_BYTE` The BYTE type in the EXIF standard.
`static short`	`TYPE_UNSIGNED_LONG` The LONG type in the EXIF standard.
`static short`	`TYPE_UNSIGNED_RATIONAL` The RATIONAL type of EXIF standard.
`static short`	`TYPE_UNSIGNED_SHORT` The SHORT type in the EXIF standard.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`long`	`forceGetValueAsLong(long defaultValue)` Gets a long representation of the value.
`java.lang.String`	`forceGetValueAsString()` Gets a string representation of the value.
`protected void`	`forceSetComponentCount(int count)` Sets the component count of this tag.
`protected void`	`getBytes(byte[] buf)` Equivalent to getBytes(buffer, 0, buffer.length).
`protected void`	`getBytes(byte[] buf, int offset, int length)` Gets the `TYPE_UNDEFINED` or `TYPE_UNSIGNED_BYTE` data.
`int`	`getComponentCount()` Gets the component count of this tag.
`int`	`getDataSize()` Gets the total data size in bytes of the value of this tag.
`short`	`getDataType()` Gets the data type of this tag
`static int`	`getElementSize(short type)` Gets the element size of the given data type in bytes.
`int`	`getIfd()` Returns the ID of the IFD this tag belongs to.
`protected int`	`getOffset()` Gets the offset of this tag.
`protected Rational`	`getRational(int index)` Gets the `TYPE_RATIONAL` or `TYPE_UNSIGNED_RATIONAL` data.
`protected java.lang.String`	`getString()` Gets the `TYPE_ASCII` data.
`protected byte[]`	`getStringByte()`
`short`	`getTagId()` Gets the TID of this tag.
`java.lang.Object`	`getValue()` Gets the tag's value or null if none exists.
`byte`	`getValueAsByte(byte defaultValue)` Gets the value as a byte.
`byte[]`	`getValueAsBytes()` Gets the value as a byte array.
`int`	`getValueAsInt(int defaultValue)` Gets the value as an int.
`int[]`	`getValueAsInts()` Gets the value as an array of ints.
`long`	`getValueAsLong(long defaultValue)` Gets the value or null if none exists.
`long[]`	`getValueAsLongs()` Gets the value as an array of longs.
`Rational`	`getValueAsRational(long defaultValue)` Gets the value as a Rational.
`Rational`	`getValueAsRational(Rational defaultValue)` Gets the value as a Rational.
`Rational[]`	`getValueAsRationals()` Gets the value as an array of Rationals.
`java.lang.String`	`getValueAsString()` Gets the value as a String.
`java.lang.String`	`getValueAsString(java.lang.String defaultValue)` Gets the value as a String.
`protected long`	`getValueAt(int index)` Gets the value for type `TYPE_ASCII`, `TYPE_LONG`, `TYPE_UNDEFINED`, `TYPE_UNSIGNED_BYTE`, `TYPE_UNSIGNED_LONG`, or `TYPE_UNSIGNED_SHORT`.
`protected boolean`	`hasDefinedCount()`
`boolean`	`hasValue()` Returns true if this ExifTag contains value; otherwise, this tag will contain an offset value that is determined when the tag is written.
`static boolean`	`isValidIfd(int ifdId)` Returns true if the given IFD is a valid IFD.
`static boolean`	`isValidType(short type)` Returns true if a given type is a valid tag type.
`protected void`	`setHasDefinedCount(boolean d)`
`protected void`	`setIfd(int ifdId)`
`protected void`	`setOffset(int offset)` Sets the offset of this tag.
`boolean`	`setTimeValue(long time)` Sets a timestamp to this tag.
`boolean`	`setValue(byte value)` Sets byte value into this tag.
`boolean`	`setValue(byte[] value)` Equivalent to setValue(value, 0, value.length).
`boolean`	`setValue(byte[] value, int offset, int length)` Sets byte values into this tag.
`boolean`	`setValue(int value)` Sets integer value into this tag.
`boolean`	`setValue(int[] value)` Sets integer values into this tag.
`boolean`	`setValue(long value)` Sets long values into this tag.
`boolean`	`setValue(long[] value)` Sets long values into this tag.
`boolean`	`setValue(java.lang.Object obj)` Sets the value for this tag using an appropriate setValue method for the given object.
`boolean`	`setValue(Rational value)` Sets a Rational value into this tag.
`boolean`	`setValue(Rational[] value)` Sets Rational values into this tag.
`boolean`	`setValue(java.lang.String value)` Sets a string value into this tag.
`java.lang.String`	`toString()`

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

- Field Detail
  - TYPE_ASCII
```
public static final short TYPE_ASCII
```
    The ASCII type in the EXIF standard. An 8-bit byte containing one 7-bit ASCII code. The final byte is terminated with NULL.
    
    See Also:
    
    Constant Field Values
  - TYPE_LONG
```
public static final short TYPE_LONG
```
    The SLONG type in the EXIF standard. A 32-bit (4-byte) signed integer (2's complement notation).
    
    See Also:
    
    Constant Field Values
  - TYPE_RATIONAL
```
public static final short TYPE_RATIONAL
```
    The SRATIONAL type of EXIF standard. It consists of two SLONGs. The first one is the numerator and the second one is the denominator.
    
    See Also:
    
    Constant Field Values
  - TYPE_UNDEFINED
```
public static final short TYPE_UNDEFINED
```
    The UNDEFINED type in the EXIF standard. An 8-bit byte that can take any value depending on the field definition.
    
    See Also:
    
    Constant Field Values
  - TYPE_UNSIGNED_BYTE
```
public static final short TYPE_UNSIGNED_BYTE
```
    The BYTE type in the EXIF standard. An 8-bit unsigned integer.
    
    See Also:
    
    Constant Field Values
  - TYPE_UNSIGNED_LONG
```
public static final short TYPE_UNSIGNED_LONG
```
    The LONG type in the EXIF standard. A 32-bit (4-byte) unsigned integer
    
    See Also:
    
    Constant Field Values
  - TYPE_UNSIGNED_RATIONAL
```
public static final short TYPE_UNSIGNED_RATIONAL
```
    The RATIONAL type of EXIF standard. It consists of two LONGs. The first one is the numerator and the second one expresses the denominator.
    
    See Also:
    
    Constant Field Values
  - TYPE_UNSIGNED_SHORT
```
public static final short TYPE_UNSIGNED_SHORT
```
    The SHORT type in the EXIF standard. A 16-bit (2-byte) unsigned integer
    
    See Also:
    
    Constant Field Values
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - forceGetValueAsLong
```
public long forceGetValueAsLong(long defaultValue)
```
    Gets a long representation of the value.
    
    Parameters:
    
    defaultValue - value to return if there is no value or value is a rational with a denominator of 0.
    
    Returns:
    
    the tag's value as a long, or defaultValue if no representation exists.
  - forceGetValueAsString
```
public java.lang.String forceGetValueAsString()
```
    Gets a string representation of the value.
  - forceSetComponentCount
```
protected void forceSetComponentCount(int count)
```
    Sets the component count of this tag. Call this function before setValue() if the length of value does not match the component count.
  - getBytes
```
protected void getBytes(byte[] buf)
```
    Equivalent to getBytes(buffer, 0, buffer.length).
  - getBytes
```
protected void getBytes(byte[] buf,
                        int offset,
                        int length)
```
    Gets the TYPE_UNDEFINED or TYPE_UNSIGNED_BYTE data.
    
    Parameters:
    
    buf - the byte array in which to store the bytes read.
    
    offset - the initial position in buffer to store the bytes.
    
    length - the maximum number of bytes to store in buffer. If length > component count, only the valid bytes will be stored.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the type is NOT TYPE_UNDEFINED or TYPE_UNSIGNED_BYTE.
  - getComponentCount
```
public int getComponentCount()
```
    Gets the component count of this tag.
  - getDataSize
```
public int getDataSize()
```
    Gets the total data size in bytes of the value of this tag.
  - getDataType
```
public short getDataType()
```
    Gets the data type of this tag
    
    See Also:
    
    TYPE_ASCII, TYPE_LONG, TYPE_RATIONAL, TYPE_UNDEFINED, TYPE_UNSIGNED_BYTE, TYPE_UNSIGNED_LONG, TYPE_UNSIGNED_RATIONAL, TYPE_UNSIGNED_SHORT
  - getElementSize
```
public static int getElementSize(short type)
```
    Gets the element size of the given data type in bytes.
    
    See Also:
    
    TYPE_ASCII, TYPE_LONG, TYPE_RATIONAL, TYPE_UNDEFINED, TYPE_UNSIGNED_BYTE, TYPE_UNSIGNED_LONG, TYPE_UNSIGNED_RATIONAL, TYPE_UNSIGNED_SHORT
  - getIfd
```
public int getIfd()
```
    Returns the ID of the IFD this tag belongs to.
    
    See Also:
    
    IfdId.TYPE_IFD_0, IfdId.TYPE_IFD_1, IfdId.TYPE_IFD_EXIF, IfdId.TYPE_IFD_GPS, IfdId.TYPE_IFD_INTEROPERABILITY
  - getOffset
```
protected int getOffset()
```
    Gets the offset of this tag. This is only valid if this data size > 4 and contains an offset to the location of the actual value.
  - getRational
```
protected Rational getRational(int index)
```
    Gets the TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL data.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the type is NOT TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL.
  - getString
```
protected java.lang.String getString()
```
    Gets the TYPE_ASCII data.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the type is NOT TYPE_ASCII.
  - getStringByte
```
protected byte[] getStringByte()
```
  - getTagId
```
public short getTagId()
```
    Gets the TID of this tag.
  - getValue
```
public java.lang.Object getValue()
```
    Gets the tag's value or null if none exists.
  - getValueAsByte
```
public byte getValueAsByte(byte defaultValue)
```
    Gets the value as a byte. If there are more than 1 bytes in this value, gets the first byte. This method should be used for tags of type TYPE_UNDEFINED or TYPE_UNSIGNED_BYTE.
    
    Parameters:
    
    defaultValue - the byte to return if tag's value does not exist or cannot be converted to a byte.
    
    Returns:
    
    the tag's value as a byte, or the defaultValue.
  - getValueAsBytes
```
public byte[] getValueAsBytes()
```
    Gets the value as a byte array. This method should be used for tags of type TYPE_UNDEFINED or TYPE_UNSIGNED_BYTE.
    
    Returns:
    
    the value as a byte array, or null if the tag's value does not exist or cannot be converted to a byte array.
  - getValueAsInt
```
public int getValueAsInt(int defaultValue)
```
    Gets the value as an int. If there are more than 1 ints in this value, gets the first one. This method should be used for tags of type TYPE_UNSIGNED_SHORT, TYPE_UNSIGNED_LONG.
    
    Parameters:
    
    defaultValue - the int to return if tag's value does not exist or cannot be converted to an int.
    
    Returns:
    
    the tag's value as a int, or the defaultValue.
  - getValueAsInts
```
public int[] getValueAsInts()
```
    Gets the value as an array of ints. This method should be used for tags of type TYPE_UNSIGNED_SHORT, TYPE_UNSIGNED_LONG.
    
    Returns:
    
    the value as as an array of ints, or null if the tag's value does not exist or cannot be converted to an array of ints.
  - getValueAsLong
```
public long getValueAsLong(long defaultValue)
```
    Gets the value or null if none exists. If there are more than 1 longs in this value, gets the first one. This method should be used for tags of type TYPE_UNSIGNED_LONG.
    
    Parameters:
    
    defaultValue - the long to return if tag's value does not exist or cannot be converted to a long.
    
    Returns:
    
    the tag's value as a long, or the defaultValue.
  - getValueAsLongs
```
public long[] getValueAsLongs()
```
    Gets the value as an array of longs. This method should be used for tags of type TYPE_UNSIGNED_LONG.
    
    Returns:
    
    the value as as an array of longs, or null if the tag's value does not exist or cannot be converted to an array of longs.
  - getValueAsRational
```
public Rational getValueAsRational(long defaultValue)
```
    Gets the value as a Rational. If there are more than 1 Rationals in this value, gets the first one. This method should be used for tags of type TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL.
    
    Parameters:
    
    defaultValue - the numerator of the Rational to return if tag's value does not exist or cannot be converted to a Rational (the denominator will be 1).
    
    Returns:
    
    the tag's value as a Rational, or the defaultValue.
  - getValueAsRational
```
public Rational getValueAsRational(Rational defaultValue)
```
    Gets the value as a Rational. If there are more than 1 Rationals in this value, gets the first one. This method should be used for tags of type TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL.
    
    Parameters:
    
    defaultValue - the Rational to return if tag's value does not exist or cannot be converted to a Rational.
    
    Returns:
    
    the tag's value as a Rational, or the defaultValue.
  - getValueAsRationals
```
public Rational[] getValueAsRationals()
```
    Gets the value as an array of Rationals. This method should be used for tags of type TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL.
    
    Returns:
    
    the value as as an array of Rationals, or null if the tag's value does not exist or cannot be converted to an array of Rationals.
  - getValueAsString
```
public java.lang.String getValueAsString()
```
    Gets the value as a String. This method should be used for tags of type TYPE_ASCII.
    
    Returns:
    
    the value as a String, or null if the tag's value does not exist or cannot be converted to a String.
  - getValueAsString
```
public java.lang.String getValueAsString(java.lang.String defaultValue)
```
    Gets the value as a String. This method should be used for tags of type TYPE_ASCII.
    
    Parameters:
    
    defaultValue - the String to return if the tag's value does not exist or cannot be converted to a String.
    
    Returns:
    
    the tag's value as a String, or the defaultValue.
  - getValueAt
```
protected long getValueAt(int index)
```
    Gets the value for type TYPE_ASCII, TYPE_LONG, TYPE_UNDEFINED, TYPE_UNSIGNED_BYTE, TYPE_UNSIGNED_LONG, or TYPE_UNSIGNED_SHORT. For TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL, call getRational(int) instead.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the data type is TYPE_RATIONAL or TYPE_UNSIGNED_RATIONAL.
  - hasDefinedCount
```
protected boolean hasDefinedCount()
```
  - hasValue
```
public boolean hasValue()
```
    Returns true if this ExifTag contains value; otherwise, this tag will contain an offset value that is determined when the tag is written.
  - isValidIfd
```
public static boolean isValidIfd(int ifdId)
```
    Returns true if the given IFD is a valid IFD.
  - isValidType
```
public static boolean isValidType(short type)
```
    Returns true if a given type is a valid tag type.
  - setHasDefinedCount
```
protected void setHasDefinedCount(boolean d)
```
  - setIfd
```
protected void setIfd(int ifdId)
```
  - setOffset
```
protected void setOffset(int offset)
```
    Sets the offset of this tag.
  - setTimeValue
```
public boolean setTimeValue(long time)
```
    Sets a timestamp to this tag. The method converts the timestamp with the format of "yyyy:MM:dd kk:mm:ss" and calls setValue(String). This method will fail if the data type is not TYPE_ASCII or the component count of this tag is not 20 or undefined.
    
    Parameters:
    
    time - the number of milliseconds since Jan. 1, 1970 GMT
    
    Returns:
    
    true on success
  - setValue
```
public boolean setValue(byte value)
```
    Sets byte value into this tag. This method should be used for tags of type TYPE_UNSIGNED_BYTE or TYPE_UNDEFINED. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_BYTE or TYPE_UNDEFINED .
    - The component count in the definition for this tag is not 1.
  - setValue
```
public boolean setValue(byte[] value)
```
    Equivalent to setValue(value, 0, value.length).
  - setValue
```
public boolean setValue(byte[] value,
                        int offset,
                        int length)
```
    Sets byte values into this tag. This method should be used for tags of type TYPE_UNSIGNED_BYTE or TYPE_UNDEFINED. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_BYTE or TYPE_UNDEFINED .
    - The length does NOT match the component count in the definition for this tag.
  - setValue
```
public boolean setValue(int value)
```
    Sets integer value into this tag. This method should be used for tags of type TYPE_UNSIGNED_SHORT, or TYPE_LONG. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_SHORT, TYPE_UNSIGNED_LONG, or TYPE_LONG.
    - The value overflows.
    - The component count in the definition of this tag is not 1.
  - setValue
```
public boolean setValue(int[] value)
```
    Sets integer values into this tag. This method should be used for tags of type TYPE_UNSIGNED_SHORT. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_SHORT, TYPE_UNSIGNED_LONG, or TYPE_LONG.
    - The value overflows.
    - The value.length does NOT match the component count in the definition for this tag.
  - setValue
```
public boolean setValue(long value)
```
    Sets long values into this tag. This method should be used for tags of type TYPE_UNSIGNED_LONG. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_LONG.
    - The value overflows.
    - The component count in the definition for this tag is not 1.
  - setValue
```
public boolean setValue(long[] value)
```
    Sets long values into this tag. This method should be used for tags of type TYPE_UNSIGNED_LONG. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_LONG.
    - The value overflows.
    - The value.length does NOT match the component count in the definition for this tag.
  - setValue
```
public boolean setValue(java.lang.Object obj)
```
    Sets the value for this tag using an appropriate setValue method for the given object. This method will fail if:
    - The corresponding setValue method for the class of the object passed in would fail.
    - There is no obvious way to cast the object passed in into an EXIF tag type.
  - setValue
```
public boolean setValue(Rational value)
```
    Sets a Rational value into this tag. This method should be used for tags of type TYPE_UNSIGNED_RATIONAL, or TYPE_RATIONAL. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_RATIONAL or TYPE_RATIONAL.
    - The value overflows.
    - The component count in the definition for this tag is not 1.
    See Also:
    
    Rational
  - setValue
```
public boolean setValue(Rational[] value)
```
    Sets Rational values into this tag. This method should be used for tags of type TYPE_UNSIGNED_RATIONAL, or TYPE_RATIONAL. This method will fail if:
    - The component type of this tag is not TYPE_UNSIGNED_RATIONAL or TYPE_RATIONAL.
    - The value overflows.
    - The value.length does NOT match the component count in the definition for this tag.
    See Also:
    
    Rational
  - setValue
```
public boolean setValue(java.lang.String value)
```
    Sets a string value into this tag. This method should be used for tags of type TYPE_ASCII. The string is converted to an ASCII string. Characters that cannot be converted are replaced with '?'. The length of the string must be equal to either (component count -1) or (component count). The final byte will be set to the string null terminator '\0', overwriting the last character in the string if the value.length is equal to the component count. This method will fail if:
    - The data type is not TYPE_ASCII or TYPE_UNDEFINED.
    - The length of the string is not equal to (component count -1) or (component count) in the definition for this tag.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ExifTagInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_ASCII

TYPE_LONG

TYPE_RATIONAL

TYPE_UNDEFINED

TYPE_UNSIGNED_BYTE

TYPE_UNSIGNED_LONG

TYPE_UNSIGNED_RATIONAL

TYPE_UNSIGNED_SHORT

Method Detail

equals

forceGetValueAsLong

forceGetValueAsString

forceSetComponentCount

getBytes

getBytes

getComponentCount

getDataSize

getDataType

getElementSize

getIfd

getOffset

getRational

getString

getStringByte

getTagId

getValue

getValueAsByte

getValueAsBytes

getValueAsInt

getValueAsInts

getValueAsLong

getValueAsLongs

getValueAsRational

getValueAsRational

getValueAsRationals

getValueAsString

getValueAsString

getValueAt

hasDefinedCount

hasValue

isValidIfd

isValidType

setHasDefinedCount

setIfd

setOffset

setTimeValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

toString