Class PaletteEntryForValue
java.lang.Object
org.apache.commons.imaging.formats.tiff.photometricinterpreters.floatingpoint.PaletteEntryForValue
- All Implemented Interfaces:
PaletteEntry
Provides a palette entry for a color assignment to a single value. This class will assign a color to a value only if it is an exact match for the input. This
class will also support Float.NaN
-
Constructor Summary
ConstructorsConstructorDescriptionPaletteEntryForValue
(float value, Color color) Constructs a palette entry for a single value. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates that the entry covers exactly one unique value (including, potentially, Float.NaN).int
getArgb
(float f) Gets the integer ARGB color assignment associated with the input value.getColor
(float f) Gets the color assignment associated with the input value.float
Gets the lower-bound value for the palette entryfloat
Gets the upper-bound value for the palette entryboolean
isCovered
(float f) Indicates whether the indicated floating-point value is within the range covered by this palette entry and can be assigned a valid color by the implementation.toString()
-
Constructor Details
-
PaletteEntryForValue
Constructs a palette entry for a single value.This class will support color-assignments for Float.NaN.
- Parameters:
value
- the color value associated with this palette entry; a Float.NaN is allowed.color
- the color assigned to value
-
-
Method Details
-
coversSingleEntry
Description copied from interface:PaletteEntry
Indicates that the entry covers exactly one unique value (including, potentially, Float.NaN).- Specified by:
coversSingleEntry
in interfacePaletteEntry
- Returns:
- true if the entry covers exactly one unique value
-
getArgb
Description copied from interface:PaletteEntry
Gets the integer ARGB color assignment associated with the input value. If the input value is not within the covered range of this instance, the return value is undefined (though the value zero is often used).- Specified by:
getArgb
in interfacePaletteEntry
- Parameters:
f
- valid floating point value, or a NaN.- Returns:
- an integer value
-
getColor
Description copied from interface:PaletteEntry
Gets the color assignment associated with the input value. If the input value is not within the covered range of this instance, the return value is undefined (though a null return is often used).- Specified by:
getColor
in interfacePaletteEntry
- Parameters:
f
- a valid floating point value, or a NaN.- Returns:
- a valid color instance or, potentially, a null if the floating point input is not within the covered range.
-
getLowerBound
Description copied from interface:PaletteEntry
Gets the lower-bound value for the palette entry- Specified by:
getLowerBound
in interfacePaletteEntry
- Returns:
- if defined, a valid floating point value; otherwise, a null.
-
getUpperBound
Description copied from interface:PaletteEntry
Gets the upper-bound value for the palette entry- Specified by:
getUpperBound
in interfacePaletteEntry
- Returns:
- if defined, a valid floating point value; otherwise, a null.
-
isCovered
Description copied from interface:PaletteEntry
Indicates whether the indicated floating-point value is within the range covered by this palette entry and can be assigned a valid color by the implementation.- Specified by:
isCovered
in interfacePaletteEntry
- Parameters:
f
- a valid floating point value, or a NaN.- Returns:
- true if the entry can assign a color to the entry; otherwise, false.
-
toString
-