Index (ImCache 21.4.0 API)

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(A, B, C) - Method in interface io.github.palexdev.imcache.utils.TriConsumer
accept(T) - Method in interface io.github.palexdev.imcache.utils.ThrowingConsumer
accept(T, U, V) - Method in interface io.github.palexdev.imcache.utils.ThrowingTriConsumer
AddText - Class in io.github.palexdev.imcache.transforms: A class that implements the Transform interface to add text to a BufferedImage given the text and the position.
AddText(String, AddText.Position) - Constructor for class io.github.palexdev.imcache.transforms.AddText
AddText(String, AddText.Position, int, int, Font, Color) - Constructor for class io.github.palexdev.imcache.transforms.AddText
AddText.Position - Enum Class in io.github.palexdev.imcache.transforms
as(Function<byte[], T>) - Method in class io.github.palexdev.imcache.core.ImImage: Converts the raw image data in this wrapper to the desired T type using the given function.
asImage() - Method in class io.github.palexdev.imcache.core.ImImage: Converts the raw image data in this wrapper to a BufferedImage using ImageUtils.toImage(Object).
asMap() - Method in interface io.github.palexdev.imcache.cache.Cache
asMap() - Method in class io.github.palexdev.imcache.cache.ImgCache
AspectRatioCrop - Class in io.github.palexdev.imcache.transforms: The AspectRatioCrop class is an implementation of the Transform interface that crops an image to a specified target aspect ratio.
AspectRatioCrop(int, int) - Constructor for class io.github.palexdev.imcache.transforms.AspectRatioCrop
asStream() - Method in class io.github.palexdev.imcache.core.ImImage: Converts the raw image data in this wrapper to a InputStream using ImageUtils.toStream(String, Object).
AsyncUtils - Class in io.github.palexdev.imcache.utils: A utility class for asynchronous operations on virtual threads.
AVI - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
AVIF - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType

B

BMP - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
BOTTOM_CENTER - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
BOTTOM_LEFT - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
BOTTOM_RIGHT - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
Brightness - Class in io.github.palexdev.imcache.transforms: The Brightness class implements the Transform interface and provides functionality to adjust the brightness level of a given image.
Brightness(int) - Constructor for class io.github.palexdev.imcache.transforms.Brightness

C

cache - Variable in class io.github.palexdev.imcache.cache.ImgCache
Cache<V> - Interface in io.github.palexdev.imcache.cache: Generic cache API to store items by a unique string key, often referred to as 'id' (see also WithID).
CACHE_HIT - Enum constant in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: The request has succeeded, but the resource was found in the cache.
cacheConfig(Supplier<ImgCache<?>>) - Method in class io.github.palexdev.imcache.core.ImCache: Replaces the current cache with a new one generated by the given config supplier.
capacity - Variable in class io.github.palexdev.imcache.cache.ImgCache
CENTER - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
CENTER_LEFT - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
CENTER_RIGHT - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
CenterCrop - Class in io.github.palexdev.imcache.transforms: The CenterCrop class implements a center-cropping image transformation.
CenterCrop(double, double) - Constructor for class io.github.palexdev.imcache.transforms.CenterCrop
CircleCrop - Class in io.github.palexdev.imcache.transforms: The CircleCrop class implements a circular cropping image transformation.
CircleCrop(Color, Color, float) - Constructor for class io.github.palexdev.imcache.transforms.CircleCrop
clear() - Method in interface io.github.palexdev.imcache.cache.Cache: Clears the cache
clear() - Method in class io.github.palexdev.imcache.cache.ImgCache: Removes all entries from the backing data structure.
clear() - Method in class io.github.palexdev.imcache.core.ImCache: Delegates to ImgCache.clear().
clear(DiskCache.ClearMode) - Method in class io.github.palexdev.imcache.cache.DiskCache
computePosition(int, int, int, int) - Method in enum class io.github.palexdev.imcache.transforms.AddText.Position
contains(WithID) - Method in interface io.github.palexdev.imcache.cache.Cache: Delegates to Cache.contains(String)
contains(String) - Method in interface io.github.palexdev.imcache.cache.Cache
contains(String) - Method in class io.github.palexdev.imcache.cache.ImgCache
Contrast - Class in io.github.palexdev.imcache.transforms: The Contrast class represents an image transformation that adjusts the contrast of an input BufferedImage.
Contrast(float) - Constructor for class io.github.palexdev.imcache.transforms.Contrast

D

DEFAULT_CACHE_PATH - Static variable in interface io.github.palexdev.imcache.cache.Cache: Default cache path: '${home}/.imcache'
DEFAULT_CAPACITY - Static variable in interface io.github.palexdev.imcache.cache.Cache: Default cache capacity: 100 entries
delete(File) - Method in class io.github.palexdev.imcache.cache.DiskCache: Attempts to delete the given file.
deserialize(File) - Static method in class io.github.palexdev.imcache.utils.ImageUtils: Deserializes the given file to an ImImage object only if the format version matches ImageUtils.FILE_FORMAT_VERSION.
DISK_AND_MEMORY - Enum constant in enum class io.github.palexdev.imcache.cache.DiskCache.ClearMode
DiskCache - Class in io.github.palexdev.imcache.cache: Concrete implementation of DiskCache that stores images on the file system and keeps them in memory as Files.
DiskCache() - Constructor for class io.github.palexdev.imcache.cache.DiskCache
DiskCache(Path) - Constructor for class io.github.palexdev.imcache.cache.DiskCache
DiskCache(SequencedMap<String, File>, Path) - Constructor for class io.github.palexdev.imcache.cache.DiskCache
DiskCache.ClearMode - Enum Class in io.github.palexdev.imcache.cache

E

equals(Object) - Method in class io.github.palexdev.imcache.core.ImImage
equals(Object) - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.palexdev.imcache.utils.OptionalWrapper: Indicates whether some other object is "equal to" this one.
error() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns the value of the error record component.
execute() - Method in class io.github.palexdev.imcache.core.ImRequest: Convenience method for executing the request without a callback.
execute(Consumer<ImRequest.Result>) - Method in class io.github.palexdev.imcache.core.ImRequest: Core method responsible for fetching an image either from its source URL or from the cache if present (unless ImRequest.overwrite(boolean) was set to true).
executeAsync(Consumer<ImRequest.Result>) - Method in class io.github.palexdev.imcache.core.ImRequest: Executes the request asynchronously by using AsyncUtils.

F

FAILED - Enum constant in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: The request has failed for some reason.
FILE_FORMAT_VERSION - Static variable in class io.github.palexdev.imcache.utils.ImageUtils
FileUtils - Class in io.github.palexdev.imcache.utils: Utility class for file operations.
Fit - Class in io.github.palexdev.imcache.transforms: The Fit class scales an input BufferedImage while maintaining its aspect ratio, ensuring that the resulting image dimensions remain within specified maximum width and height bounds.
Fit(double, double) - Constructor for class io.github.palexdev.imcache.transforms.Fit
Flip - Class in io.github.palexdev.imcache.transforms: The Flip class is a transformation that flips a source BufferedImage either horizontally or vertically based on the specified Flip.FlipOrientation.
Flip(Flip.FlipOrientation) - Constructor for class io.github.palexdev.imcache.transforms.Flip
Flip.FlipOrientation - Enum Class in io.github.palexdev.imcache.transforms
FLV - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
forEach(BiConsumer<String, V>) - Method in class io.github.palexdev.imcache.cache.ImgCache: Delegates to Map.forEach(BiConsumer).

G

GaussianBlur - Class in io.github.palexdev.imcache.transforms: The GaussianBlur class applies a Gaussian blur filter to a given BufferedImage.
GaussianBlur() - Constructor for class io.github.palexdev.imcache.transforms.GaussianBlur
generateId(File) - Static method in interface io.github.palexdev.imcache.cache.WithID: Delegates to generateId(URL) by converting the input File to a URL with URLHandler.toURL(File).
generateId(String) - Static method in interface io.github.palexdev.imcache.cache.WithID: Generates a unique identifier with UUID.nameUUIDFromBytes(byte[]).
generateId(URL) - Static method in interface io.github.palexdev.imcache.cache.WithID: Delegates to generateId(String) by converting the input with URL.toString().
generateId(Path) - Static method in interface io.github.palexdev.imcache.cache.WithID: Delegates to generateId(File) by converting the input Path to a File.
get(WithID) - Method in interface io.github.palexdev.imcache.cache.Cache: Delegates to Cache.get(String)
get(String) - Method in interface io.github.palexdev.imcache.cache.Cache
get(String) - Method in class io.github.palexdev.imcache.cache.ImgCache
getCapacity() - Method in interface io.github.palexdev.imcache.cache.Cache
getCapacity() - Method in class io.github.palexdev.imcache.cache.ImgCache
getImage(WithID) - Method in class io.github.palexdev.imcache.cache.ImgCache: Delegates to ImgCache.getImage(String).
getImage(String) - Method in class io.github.palexdev.imcache.cache.DiskCache: Retrieves the cached file for the given id and then deserializes it with ImageUtils.deserialize(File), returning an Optional to indicate whether the cache entry was present and successfully deserialized or not.
getImage(String) - Method in class io.github.palexdev.imcache.cache.ImgCache: Implementations should define here how to load and return an image from the cache.
getImage(String) - Method in class io.github.palexdev.imcache.cache.MemoryCache: Direct access to the backing data structure, ImgCache.get(String).
getMimeType() - Method in enum class io.github.palexdev.imcache.utils.MediaType
getSavePath() - Method in class io.github.palexdev.imcache.cache.DiskCache
getSaveStrategy() - Method in class io.github.palexdev.imcache.core.ImCache
getUrlConfig() - Method in class io.github.palexdev.imcache.core.ImRequest
GIF - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
Grayscale - Class in io.github.palexdev.imcache.transforms: A transformation class that converts a source BufferedImage into its grayscale equivalent.
Grayscale() - Constructor for class io.github.palexdev.imcache.transforms.Grayscale

H

hashCode() - Method in class io.github.palexdev.imcache.core.ImImage
hashCode() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns a hash code value for this object.
hashCode() - Method in record class io.github.palexdev.imcache.utils.OptionalWrapper: Returns a hash code value for this object.
HEIC - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
HEIF - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
HORIZONTAL - Enum constant in enum class io.github.palexdev.imcache.transforms.Flip.FlipOrientation

I

ICON - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
id() - Method in interface io.github.palexdev.imcache.cache.WithID
id() - Method in class io.github.palexdev.imcache.core.ImRequest
id() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result
ifPresent(Consumer<T>) - Method in record class io.github.palexdev.imcache.utils.OptionalWrapper
ifPresentOrElse(Consumer<T>, Runnable) - Method in record class io.github.palexdev.imcache.utils.OptionalWrapper
ImageUtils - Class in io.github.palexdev.imcache.utils: Utility class for handling various image-related operations.
ImCache - module ImCache
ImCache - Class in io.github.palexdev.imcache.core: Core class which eases communication between the request system (ImRequest) and the caching system (ImgCache).
ImCache() - Constructor for class io.github.palexdev.imcache.core.ImCache
ImCache.StoreStrategy - Enum Class in io.github.palexdev.imcache.core
ImCacheException - Exception Class in io.github.palexdev.imcache.exceptions: Custom exception for handling errors that occur within the ImCache library.
ImCacheException(String) - Constructor for exception class io.github.palexdev.imcache.exceptions.ImCacheException
ImCacheException(String, Throwable) - Constructor for exception class io.github.palexdev.imcache.exceptions.ImCacheException
ImCacheException(Throwable) - Constructor for exception class io.github.palexdev.imcache.exceptions.ImCacheException
ImgCache<V> - Class in io.github.palexdev.imcache.cache: Abstract specialization of Cache which implements common functionalities such as:
ImgCache() - Constructor for class io.github.palexdev.imcache.cache.ImgCache
ImgCache(SequencedMap<String, V>) - Constructor for class io.github.palexdev.imcache.cache.ImgCache
ImImage - Class in io.github.palexdev.imcache.core: Wrapper type to represent a loaded image by its source URL and its raw byte data.
ImImage(URL, byte[]) - Constructor for class io.github.palexdev.imcache.core.ImImage
ImRequest - Class in io.github.palexdev.imcache.core: As the name suggests, this class represents a request for loading a certain image from a URL.
ImRequest(ImCache, URL) - Constructor for class io.github.palexdev.imcache.core.ImRequest
ImRequest.RequestState - Enum Class in io.github.palexdev.imcache.core: Enumeration representing the various states of a request.
ImRequest.Result - Record Class in io.github.palexdev.imcache.core: Wrapper class to represent the result of a request.
instance() - Static method in class io.github.palexdev.imcache.core.ImCache
io.github.palexdev.imcache.cache - package io.github.palexdev.imcache.cache
io.github.palexdev.imcache.core - package io.github.palexdev.imcache.core
io.github.palexdev.imcache.exceptions - package io.github.palexdev.imcache.exceptions
io.github.palexdev.imcache.transforms - package io.github.palexdev.imcache.transforms
io.github.palexdev.imcache.utils - package io.github.palexdev.imcache.utils
isEmpty() - Method in interface io.github.palexdev.imcache.cache.Cache
isFailed() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Convenience method to check if the request has failed.
isOverwrite() - Method in class io.github.palexdev.imcache.core.ImRequest
isSuccess() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Convenience method to check if the request has succeeded either with ImRequest.RequestState.SUCCEEDED or ImRequest.RequestState.CACHE_HIT.
isSupportedExtension(URL) - Static method in enum class io.github.palexdev.imcache.utils.MediaType
isSupportedMimeType(String) - Static method in enum class io.github.palexdev.imcache.utils.MediaType
isVerticalCenter() - Method in enum class io.github.palexdev.imcache.transforms.AddText.Position
isVerticalRight() - Method in enum class io.github.palexdev.imcache.transforms.AddText.Position
iterator() - Method in class io.github.palexdev.imcache.cache.ImgCache

J

JPEG - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
JXR - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType

L

load(Path) - Static method in class io.github.palexdev.imcache.cache.DiskCache: Delegates to DiskCache.load(Path, int) with capacity set to Cache.DEFAULT_CAPACITY.
load(Path) - Static method in class io.github.palexdev.imcache.cache.MemoryCache: Delegates to MemoryCache.load(Path, int) with capacity set to Cache.DEFAULT_CAPACITY
load(Path, int) - Static method in class io.github.palexdev.imcache.cache.DiskCache: Creates a new DiskCache object and loads previously persisted images from the given path.
load(Path, int) - Static method in class io.github.palexdev.imcache.cache.MemoryCache: Creates a new MemoryCache object and loads previously persisted images from the given path.

M

MediaType - Enum Class in io.github.palexdev.imcache.utils: An enumeration representing various media types (MIME types) for images and videos.
MEMORY - Enum constant in enum class io.github.palexdev.imcache.cache.DiskCache.ClearMode: Removes cached entries only from the memory.
MemoryCache - Class in io.github.palexdev.imcache.cache: Simplest concrete implementation of ImgCache.
MemoryCache() - Constructor for class io.github.palexdev.imcache.cache.MemoryCache
MemoryCache(SequencedMap<String, ImImage>) - Constructor for class io.github.palexdev.imcache.cache.MemoryCache
MKV - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
MP4 - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
MPEG - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType

N

NO_CLEAN - Enum constant in enum class io.github.palexdev.imcache.cache.DiskCache.ClearMode: No-op.

O

of(T) - Static method in record class io.github.palexdev.imcache.utils.OptionalWrapper
ofNullable(T) - Static method in record class io.github.palexdev.imcache.utils.OptionalWrapper
optional() - Method in record class io.github.palexdev.imcache.utils.OptionalWrapper: Returns the value of the optional record component.
OptionalWrapper<T> - Record Class in io.github.palexdev.imcache.utils: A wrapper class for Optional to adapt Optional.ifPresent(Consumer) and Optional.ifPresentOrElse(Consumer, Runnable) to fluent API.
OptionalWrapper(Optional<T>) - Constructor for record class io.github.palexdev.imcache.utils.OptionalWrapper: Creates an instance of a OptionalWrapper record class.
out() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns the value of the out record component.
overwrite(boolean) - Method in class io.github.palexdev.imcache.core.ImRequest: Sets whether the current request should overwrite the cached content.

P

Pad - Class in io.github.palexdev.imcache.transforms: The Pad class implements a padding transformation for images.
Pad(double, double) - Constructor for class io.github.palexdev.imcache.transforms.Pad
Pad(double, double, Color) - Constructor for class io.github.palexdev.imcache.transforms.Pad
PNG - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType

R

rawData() - Method in class io.github.palexdev.imcache.core.ImImage
read(File) - Static method in class io.github.palexdev.imcache.utils.FileUtils: Delegates to FileUtils.read(Path) by converting the input with File.toPath().
read(Path) - Static method in class io.github.palexdev.imcache.utils.FileUtils: Reads the file's content into a byte array using Files.readAllBytes(Path).
READY - Enum constant in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: The request is ready to be executed, this is the first stage.
remove(WithID) - Method in interface io.github.palexdev.imcache.cache.Cache: Delegates to Cache.remove(String)
remove(WithID) - Method in class io.github.palexdev.imcache.core.ImCache: Delegates to ImCache.remove(WithID).
remove(String) - Method in interface io.github.palexdev.imcache.cache.Cache
remove(String) - Method in class io.github.palexdev.imcache.cache.DiskCache: Attempts to remove a cached entry for the given id, and if it is found, it's also deleted from the disk with DiskCache.delete(File).
remove(String) - Method in class io.github.palexdev.imcache.cache.ImgCache: Removes the cached resource associated with the given id.
remove(String) - Method in class io.github.palexdev.imcache.core.ImCache: Delegates to ImgCache.remove(String).
removeOldest() - Method in interface io.github.palexdev.imcache.cache.Cache: Implementations should define the logic to remove the oldest entry from the cache
removeOldest() - Method in class io.github.palexdev.imcache.cache.ImgCache: Remove the oldest cached entry.
request() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns the value of the request record component.
request(File) - Method in class io.github.palexdev.imcache.core.ImCache: Creates a new ImRequest by converting the provided File to a URL with URLHandler.toURL(File).
request(String) - Method in class io.github.palexdev.imcache.core.ImCache: Creates a new ImRequest by converting the provided string to a URL with URLHandler.toURL(String).
request(URL) - Method in class io.github.palexdev.imcache.core.ImCache: Creates a new ImRequest with the given URL.
request(Path) - Method in class io.github.palexdev.imcache.core.ImCache: Delegates to ImCache.request(File).
Resize - Class in io.github.palexdev.imcache.transforms: The Resize class scales a given BufferedImage to the specified target width and height, potentially altering the aspect ratio if the width and height ratios do not match.
Resize(double, double) - Constructor for class io.github.palexdev.imcache.transforms.Resize
resolve(ImRequest) - Static method in class io.github.palexdev.imcache.utils.URLHandler: Delegates to URLHandler.resolve(URL, ThrowingConsumer) by using ImRequest.url() and ImRequest.getUrlConfig().
resolve(URL, ThrowingConsumer<URLConnection>) - Static method in class io.github.palexdev.imcache.utils.URLHandler: Opens a connection to the given url, verifies that the content type is supported, configures the connection with the given consumer and finally transfers the resource's content to a byte array using ImageUtils.toBytes(String, Object).
result() - Method in class io.github.palexdev.imcache.core.ImRequest
Result(ImRequest, ImRequest.RequestState, ImImage, ImImage, Throwable) - Constructor for record class io.github.palexdev.imcache.core.ImRequest.Result
Result(ImRequest, ImRequest.RequestState, OptionalWrapper<ImImage>, OptionalWrapper<ImImage>, OptionalWrapper<Throwable>) - Constructor for record class io.github.palexdev.imcache.core.ImRequest.Result: Creates an instance of a Result record class.
Rotate - Class in io.github.palexdev.imcache.transforms: The Rotate class applies a rotation transformation to a given BufferedImage.
Rotate(double) - Constructor for class io.github.palexdev.imcache.transforms.Rotate
runAsync(Runnable) - Static method in class io.github.palexdev.imcache.utils.AsyncUtils
runAsync(Callable<T>) - Static method in class io.github.palexdev.imcache.utils.AsyncUtils

S

SAVE_ORIGINAL - Enum constant in enum class io.github.palexdev.imcache.core.ImCache.StoreStrategy
SAVE_TRANSFORMED - Enum constant in enum class io.github.palexdev.imcache.core.ImCache.StoreStrategy
saveTo(Path) - Method in class io.github.palexdev.imcache.cache.DiskCache: Delegates to DiskCache.saveTo(Path, ClearMode) with clear mode set to DiskCache.ClearMode.NO_CLEAN.
saveTo(Path, DiskCache.ClearMode) - Method in class io.github.palexdev.imcache.cache.DiskCache: Changes the path where cached resources are stored and clears the previous cache directory with the given clear mode.
serialize(ImImage, File) - Static method in class io.github.palexdev.imcache.utils.ImageUtils: Serializes the given ImImage object to the given file.
setCapacity(int) - Method in interface io.github.palexdev.imcache.cache.Cache: Sets the maximum allowed number of entries in the cache.
setCapacity(int) - Method in class io.github.palexdev.imcache.cache.ImgCache
setColor(Color) - Method in class io.github.palexdev.imcache.transforms.AddText
setFont(Font) - Method in class io.github.palexdev.imcache.transforms.AddText
setImageConverter(Function<BufferedImage, byte[]>) - Method in class io.github.palexdev.imcache.core.ImRequest: This function is used to convert a BufferedImage back to a byte array after applying all the transformations.
setStoreStrategy(ImCache.StoreStrategy) - Method in class io.github.palexdev.imcache.core.ImCache: Sets the ImCache.StoreStrategy to be used when saving the result of a request.
setXOffset(int) - Method in class io.github.palexdev.imcache.transforms.AddText
setYOffset(int) - Method in class io.github.palexdev.imcache.transforms.AddText
size() - Method in interface io.github.palexdev.imcache.cache.Cache
size() - Method in class io.github.palexdev.imcache.cache.ImgCache
Sketch - Class in io.github.palexdev.imcache.transforms: The Sketch class implements a stylized edge-detection transformation that simulates a sketch or pencil-drawing effect on an image.
Sketch() - Constructor for class io.github.palexdev.imcache.transforms.Sketch
src() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns the value of the src record component.
STARTED - Enum constant in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: The request is being worked on.
state() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns the value of the state record component.
state() - Method in class io.github.palexdev.imcache.core.ImRequest: Convenience method for accessing the request's state from its result.
storage() - Method in class io.github.palexdev.imcache.core.ImCache
store(WithID, ImImage) - Method in class io.github.palexdev.imcache.cache.ImgCache: Delegates to ImgCache.store(String, ImImage).
store(WithID, V) - Method in interface io.github.palexdev.imcache.cache.Cache: Delegates to Cache.store(String, V)
store(ImRequest, ImImage, ImImage) - Method in class io.github.palexdev.imcache.core.ImCache: Stores a completed request in the cache by its ImRequest.id().
store(String, ImImage) - Method in class io.github.palexdev.imcache.cache.DiskCache: Creates a file in the cache directory (DiskCache.getSavePath()) with the given id as the name.
store(String, ImImage) - Method in class io.github.palexdev.imcache.cache.ImgCache: Implementations should define here the logic to store images in the cache.
store(String, V) - Method in interface io.github.palexdev.imcache.cache.Cache
store(String, V) - Method in class io.github.palexdev.imcache.cache.ImgCache: Stores the given cache entry in the backing data structure.
SUCCEEDED - Enum constant in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: The request has succeeded.
SVG - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType

T

ThrowingConsumer<T> - Interface in io.github.palexdev.imcache.utils
ThrowingTriConsumer<T,U,V> - Interface in io.github.palexdev.imcache.utils
TIFF - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
toBytes(String, Object) - Static method in class io.github.palexdev.imcache.utils.ImageUtils: Given an image as a generic type, converts it to a byte array.
toDisk(Path) - Method in class io.github.palexdev.imcache.cache.MemoryCache: Creates a new DiskCache object, sets its capacity the same as this cache and finally calls DiskCache.store(String, ImImage) on each entry in this cache.
toImage(Object) - Static method in class io.github.palexdev.imcache.utils.ImageUtils: Given an image as a generic type, converts it to a BufferedImage object.
TOP_CENTER - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
TOP_LEFT - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
TOP_RIGHT - Enum constant in enum class io.github.palexdev.imcache.transforms.AddText.Position
toStream(String, Object) - Static method in class io.github.palexdev.imcache.utils.ImageUtils: Given an image as a generic type, converts it to an InputStream object.
toString() - Method in class io.github.palexdev.imcache.core.ImImage
toString() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Returns a string representation of this record class.
toString() - Method in class io.github.palexdev.imcache.core.ImRequest
toString() - Method in record class io.github.palexdev.imcache.utils.OptionalWrapper: Returns a string representation of this record class.
toURL(File) - Static method in class io.github.palexdev.imcache.utils.URLHandler: Converts the given File to a URL using File.toURI() and URI.toURL().
toURL(String) - Static method in class io.github.palexdev.imcache.utils.URLHandler: Creates a URL from the given string using URI.create(String) and URI.toURL().
transform(ImImage) - Method in class io.github.palexdev.imcache.core.ImRequest: If any Transforms were added before the execution, they are applied on the given source image, otherwise returns the source image unchanged.
transform(Transform) - Method in class io.github.palexdev.imcache.core.ImRequest: Adds the given Transform to the request.
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.AddText
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.AspectRatioCrop
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Brightness
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.CenterCrop
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.CircleCrop
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Contrast
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Fit
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Flip
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.GaussianBlur
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Grayscale
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Pad
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Resize
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Rotate
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Sketch
transform(BufferedImage) - Method in interface io.github.palexdev.imcache.transforms.Transform
transform(BufferedImage) - Method in class io.github.palexdev.imcache.transforms.Vignette
Transform - Interface in io.github.palexdev.imcache.transforms: Represents a single operation that transforms a source BufferedImage into a modified BufferedImage.
TransformException - Exception Class in io.github.palexdev.imcache.exceptions: Custom exception thrown to indicate that an error occurred during a transform operation.
TransformException(String) - Constructor for exception class io.github.palexdev.imcache.exceptions.TransformException
TriConsumer<A,B,C> - Interface in io.github.palexdev.imcache.utils

U

unwrapError() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Convenience method for accessing the error directly.
unwrapOut() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Convenience method for accessing the transformed image directly.
unwrapSrc() - Method in record class io.github.palexdev.imcache.core.ImRequest.Result: Convenience method for accessing the source image directly.
url() - Method in class io.github.palexdev.imcache.core.ImImage
url() - Method in class io.github.palexdev.imcache.core.ImRequest: The URL at which the resource can be found.
urlConfig(ThrowingConsumer<URLConnection>) - Method in class io.github.palexdev.imcache.core.ImRequest: A consumer that allows you to configure the URLConnection used to fetch the resource from its URL.
URLHandler - Class in io.github.palexdev.imcache.utils: Utility class for handling URLs.

V

valueOf(String) - Static method in enum class io.github.palexdev.imcache.cache.DiskCache.ClearMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.palexdev.imcache.core.ImCache.StoreStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.palexdev.imcache.transforms.AddText.Position: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.palexdev.imcache.transforms.Flip.FlipOrientation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.palexdev.imcache.utils.MediaType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.palexdev.imcache.cache.DiskCache.ClearMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.palexdev.imcache.core.ImCache.StoreStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.palexdev.imcache.core.ImRequest.RequestState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.palexdev.imcache.transforms.AddText.Position: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.palexdev.imcache.transforms.Flip.FlipOrientation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.palexdev.imcache.utils.MediaType: Returns an array containing the constants of this enum class, in the order they are declared.
VERTICAL - Enum constant in enum class io.github.palexdev.imcache.transforms.Flip.FlipOrientation
Vignette - Class in io.github.palexdev.imcache.transforms: The Vignette class provides a transformation that applies a vignette effect to the given BufferedImage.
Vignette() - Constructor for class io.github.palexdev.imcache.transforms.Vignette

W

WEBM - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
WEBP - Enum constant in enum class io.github.palexdev.imcache.utils.MediaType
WithID - Interface in io.github.palexdev.imcache.cache: The WithID interface defines an object that can return a unique identifier.
wrap(URL, byte[]) - Static method in class io.github.palexdev.imcache.core.ImImage
wrap(Optional<T>) - Static method in record class io.github.palexdev.imcache.utils.OptionalWrapper

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form