rebuild.graphics.tiff.tags
Class SamplesPerPixelTag

java.lang.Object
  extended by rebuild.graphics.tiff.Tag
      extended by rebuild.graphics.tiff.tags.ShortTag
          extended by rebuild.graphics.tiff.tags.SamplesPerPixelTag

public final class SamplesPerPixelTag
extends ShortTag

The number of components per pixel.

Since:
BBX 1.0.1

Field Summary
 
Fields inherited from class rebuild.graphics.tiff.Tag
count, data, dataType, value
 
Constructor Summary
SamplesPerPixelTag()
          Create a new SamplesPerPixel tag.
SamplesPerPixelTag(short samples)
          Create a new SamplesPerPixel tag.
 
Method Summary
 short getSamples()
          Get the current number of samples.
static short getTagTypeValue()
          Get the Tag's type.
 boolean hasDefault()
          Get if this Tag can have a default value, often defined by a parameter-less constructor.
 boolean isDefault()
          Get if this Tag's current value is the default value.
 void setCount(int count)
          There is always only 1 element.
 void setValue(int samples)
          Set the samples per pixel to use.
 
Methods inherited from class rebuild.graphics.tiff.tags.ShortTag
extraData, getShort, setDataType, setExtraData, setShort, setupForBigTIFF, writeData
 
Methods inherited from class rebuild.graphics.tiff.Tag
equals, getBigCount, getBigValue, getCount, getDataType, getExtraData, getIfExtraDataExists, getTagType, getValue, hashCode, setCount, setValue, toString, write, write, write, write, writeBig
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SamplesPerPixelTag

public SamplesPerPixelTag()
Create a new SamplesPerPixel tag.


SamplesPerPixelTag

public SamplesPerPixelTag(short samples)
Create a new SamplesPerPixel tag.

Parameters:
samples - The number of components per pixel.
Method Detail

getTagTypeValue

public static short getTagTypeValue()
Get the Tag's type.

Returns:
The Tag's type.

setCount

public void setCount(int count)
There is always only 1 element.

Overrides:
setCount in class ShortTag
Parameters:
count - The number of Writer.SHORT contained in the tag. If the number is bigger than the current count then it will add 0 Writer.SHORT, else it will remove the Writer.SHORT.
See Also:
setCount

setValue

public void setValue(int samples)
Set the samples per pixel to use.

Overrides:
setValue in class Tag
Parameters:
samples - The samples per pixel to use.
See Also:
getValue

getSamples

public short getSamples()
Get the current number of samples.

Returns:
The number of samples that this tag is set to.

hasDefault

public boolean hasDefault()
Get if this Tag can have a default value, often defined by a parameter-less constructor.

Overrides:
hasDefault in class ShortTag
Returns:
true if the Tag has a default value, false if otherwise. Default is false.

isDefault

public boolean isDefault()
Get if this Tag's current value is the default value. This is ignored if Tag#hasDefault() returns false.

Overrides:
isDefault in class ShortTag
Returns:
true if the Tag's value is the default value, false if otherwise.