Index

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

A

AbstractMediaPayloadBuilder<T> - Class in net.ygbstudio.powerwp4j.base.extension.builders
Abstract builder for media attachment payloads.
AbstractMediaPayloadBuilder() - Constructor for class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Creates an empty media payload builder base.
AbstractPayloadBuilder<T> - Class in net.ygbstudio.powerwp4j.base.extension.builders
Abstract class for payload builders that can be used to simplify the process of building payloads for the WordPress REST API.
AbstractPayloadBuilder() - Constructor for class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Creates an empty payload builder base.
AbstractPayloadNodeBuilder<T> - Class in net.ygbstudio.powerwp4j.base.extension.builders
Abstract base class for payload builders based on ObjectNode.
AbstractPayloadNodeBuilder() - Constructor for class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Creates an empty payload node builder base.
activate() - Method in interface net.ygbstudio.powerwp4j.utils.functional.Trigger
Activates the trigger function without passing arguments or by using variables in the same scope.
activate(T) - Method in interface net.ygbstudio.powerwp4j.utils.functional.TypedTrigger
Supplies the given argument to the trigger function and activates it.
add(E, boolean) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the given propertyEnum value and boolean value to the payload node.
add(E, int) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the given propertyEnum value and int value to the payload node.
add(E, long) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the given propertyEnum value and long value to the payload node.
add(E, short) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the given propertyEnum value and short value to the payload node.
add(E, String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the given propertyEnum value and value to the payload node.
add(String, boolean) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the specified name and boolean value to the payload node.
add(String, int) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the specified name and int value to the payload node.
add(String, long) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the specified name and long value to the payload node.
add(String, short) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the specified name and short value to the payload node.
add(String, String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the specified name and value to the payload node.
add(CacheKeyEnum, E) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds a property with the given propertyEnum value and a value enum to the payload node.
add(FriendlyEnum, Collection<? extends Number>) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Adds an integer array property with the specified propertyEnum value and int value array to the payload node.
addCategory(String, String, String, JsonNode, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Adds a category to the WordPress site using the REST API.
addCategory(JsonNode) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Adds a category to the WordPress site using the REST API.
addTag(String, String, String, JsonNode, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Adds a tag to the WordPress site using the REST API.
addTag(JsonNode) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Adds a tag to the WordPress site using the REST API.
ALL - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPostType
 
ALT_TEXT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Alternative text.
altText - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Alternative text for the media attachment.
altText(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Sets the alternative text for the media attachment.
altText(String) - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadNodeBuilder
Sets the alternative text for the media attachment.
apiBaseUrl() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Returns the base URL of the WordPress REST API.
apiBaseUrl() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns the base URL of the WordPress REST API.
ASIDE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
ATTACHMENT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPostType
 
AUDIO - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
author - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
WordPress author ID.
author() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the author record component.
author(int) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the author.
author(Integer) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the author.
AUTHOR - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Author ID.

B

build() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Builds the media attachment payload as a JsonNode.
build() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Builds the payload as a JsonNode.
build() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Builds the payload node object as a JSON node.
build() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
 
build() - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadBuilder
 
builder() - Static method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Creates a new instance of WPBasicPayloadBuilder.
builder() - Static method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadBuilder
Creates a new instance of WPMediaPayloadBuilder.
builder() - Static method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadNodeBuilder
 
builder() - Static method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Returns a new instance of the payload node builder.
buildWpDeleteRequest(String, String, String, Logger) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Builds a DELETE request for the WordPress REST API.
buildWpGetRequest(String, String, String, Logger) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Builds a GET request for the WordPress REST API.
buildWpPostRequest(String, String, String, Path, Logger) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Builds a POST request for the WordPress REST API to upload a media file.
buildWpPostRequest(JsonNode, String, String, String, Logger) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Builds a POST request for the WordPress REST API.

C

CacheConstructionException - Exception Class in net.ygbstudio.powerwp4j.exceptions
CacheConstructionException is an exception that is thrown when there is an error constructing the cache.
CacheConstructionException(String) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheConstructionException
Creates a new cache construction exception with the given message.
CacheConstructionException(Supplier<String>) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheConstructionException
Creates a new cache construction exception with a lazily computed message.
CacheFileSystemException - Exception Class in net.ygbstudio.powerwp4j.exceptions
Exception thrown when a file system error occurs while working with the local cache file.
CacheFileSystemException(String) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheFileSystemException
Creates a new cache file system exception with the given message.
CacheFileSystemException(Supplier<String>) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheFileSystemException
Creates a new cache file system exception with a lazily computed message.
cacheKey() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPCacheKeySnapshot
Returns the value of the cacheKey record component.
CacheKeyEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
This interface provides a way to create enum constants that represent keys in the JSON local cache and use them with utilities in PowerWP4j.
CacheMetaDataException - Exception Class in net.ygbstudio.powerwp4j.exceptions
CacheMetaDataException is an exception that is thrown when there is an error with the cache metadata or its creation.
CacheMetaDataException(String) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheMetaDataException
Creates a new cache metadata exception with the given message.
CacheMetaDataException(String, Throwable) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheMetaDataException
Creates a new cache metadata exception with a message and an upstream exception (cause).
CacheMetaDataException(Supplier<String>) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.CacheMetaDataException
Creates a new cache metadata exception with a lazily computed message.
CacheSubKeyEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
CacheSubKeyEnum is an interface that extends the FriendlyEnum interface and is used to represent the keys nested in the values represented by CacheKeyEnum in the local cache.
cacheSubKeyMap() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPCacheKeySnapshot
Returns the value of the cacheSubKeyMap record component.
cacheSync() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Performs a cache synchronization between the local cache file and the WordPress REST API.
cacheSync(boolean) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Synchronizes the cache file with the WordPress site.
calculateTermFrequencyByClassMarker(ClassMarkerEnum, WPClassMapping<String, Long>, boolean) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Calculates the term frequency of a given class mapping by class marker.
calculateTermFrequencyByClassValue(ClassValueKeyEnum, WPClassMapping<String, Long>) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Calculates the term frequency of a given class mapping by class value key.
caption - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Caption for the media attachment.
caption(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Sets the caption for the media attachment.
caption(String) - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadNodeBuilder
Sets the caption for the media attachment.
CAPTION - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Media caption.
categories - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Category IDs associated with the payload.
categories() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the categories record component.
categories(List<Integer>) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the categories.
categories(List<T>) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the categories.
categories(Set<WPClassMapping<T, U>>) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the categories using a set of WPClassMapping objects.
CATEGORIES - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
CATEGORIES - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyValues
Category term IDs.
CATEGORY - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Category taxonomy marker.
changePostStatus(long, PostStatusEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Changes the status of a post on the WordPress site using the REST API.
changePostStatus(String, String, String, long, JsonNode, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Changes the status of a post on the WordPress site using the REST API.
CHAT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
CLASS_LIST - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
CSS class list.
ClassMarkerEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
Unified Enum interface for the WordPress taxonomy/class key markers. objects.
ClassValueKeyEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
Unified Enum interface for the WordPress class/taxonomy value representation objects.
clear() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Resets all fields of the builder to their initial state.
clear() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Resets all fields of the builder to their initial state.
clear() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Clears the payload node object, resetting it to an empty object.
clientSend(HttpRequest, Logger, boolean) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Sends a request to the WordPress REST API and returns the response wrapped in an Optional type.
CLOSED - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCommentStatus
 
COMMENT_STATUS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Comment status.
commentStatus - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
WordPress comment status value.
commentStatus() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the commentStatus record component.
commentStatus(CommentStatusEnum) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the comment status.
commentStatus(CommentStatusEnum) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the comment status.
CommentStatusEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
Interface for comment status enums that provide a unified type for addition of custom and built-in comment statuses.
configureMapper() - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Configures and returns a pre-configured ObjectMapper instance.
connectGetWP(String, String, String, Logger) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Connects to the WordPress REST API and returns the response.
connectWP(Map<QueryParamEnum, String>, WPRestPath) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Connects to the WordPress REST API and returns the response.
content - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Post content.
content() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the content record component.
content(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the content.
content(String) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the content.
CONTENT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Rendered content.
CONTENT_UPLOADS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
createPost(JsonNode) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Creates a new post in the WordPress site using the REST API.

D

date() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the date record component.
DATE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Local date.
DATE_GMT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
GMT date.
dateGmt() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the dateGmt record component.
deletePost(long) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Deletes a post from the WordPress site using the REST API.
description - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Description for the media attachment.
description - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Taxonomy description for taxonomy payloads.
description(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the description.
description(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Sets the description for the media attachment.
description(String) - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadNodeBuilder
Sets the description for the media attachment.
description(String) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the description.
DESCRIPTION - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Description text.
deserialize(HttpResponse<String>, Class<T>) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Deserializes a generic response from an HttpResponse.
deserialize(HttpResponse<String>, TypeReference<T>) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Deserializes a generic list response from an HttpResponse.
DRAFT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
 

E

enumFromValue(Class<T>, String, boolean) - Static method in class net.ygbstudio.powerwp4j.utils.Helpers
Retrieves an enum constant from a string value, with an option to match irrespectively of case.
EnvironmentScope - Enum Class in net.ygbstudio.powerwp4j.base.extension.enums
Enumeration that represents the keys for the environment variables required to connect to a WordPress site.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.models.entities.WPCacheKeySnapshot
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassGroup
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.models.entities.WPRendered
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Indicates whether some other object is "equal to" this one.
excerpt - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Post excerpt.
excerpt() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the excerpt record component.
excerpt(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the excerpt.
excerpt(String) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the excerpt.
EXCERPT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Excerpt text.

F

FEATURED_MEDIA - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Featured media ID.
featuredMedia - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Featured media attachment ID.
featuredMedia() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the featuredMedia record component.
featuredMedia(int) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the featured media.
featuredMedia(Integer) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the featured media.
fetchCache(Path, boolean, boolean) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Fetches the local cache file from the WordPress REST API.
fetchCacheFromInstancePath(boolean, boolean) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Fetches the local cache file from the WordPress REST API.
FIELD_AUTHOR - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
FIELD_EXCERPT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
FIELD_ID - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
FIELD_LINK - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
FIELD_TITLE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
FIELDS_BASE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
format - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
WordPress post format value.
format() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the format record component.
format(PostFormatEnum) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the post format.
format(PostFormatEnum) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the post format.
FORMAT - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Post format.
FriendlyEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
This interface is designed to enforce a consistent approach to Java enums in the PowerWP4j project.
from(Path) - Static method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Reads the metadata file from the given cache file path and returns an optional WPCacheMeta object.
fromConfigResource(String) - Static method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns an Optional of WPSiteInfo loaded from the specified configuration resource properties file.
fromEnv() - Static method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns a WPSiteInfo loaded from the environment variables outlined in EnvironmentScope.
fullyQualifiedDomainName() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns the value of the fullyQualifiedDomainName record component.

G

GALLERY - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
get() - Method in interface net.ygbstudio.powerwp4j.utils.functional.TriggerCallable
Triggers the callable and returns the result R.
getAltText() - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadBuilder
Returns the configured alternative text, or null if unset.
getAuthor() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured author ID, or null if unset.
getCacheAnalyzer() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Returns a new WPCacheAnalyzer instance using the cache file specified at construction time.
getCacheKeyArrayStream(CacheKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the ArrayNodes from the in-memory local cache filtered by a specified enum that follows the CacheKeyEnum interface.
getCacheKeyCount(CacheKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique cache keys from the in-memory local cache.
getCacheKeyValueSet(CacheKeyEnum, Function<? super JsonNode, ? extends V>) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns values extracted from the in-memory local cache filtered by a specified enum that follows the CacheKeyEnum interface.
getCacheKeyValueStream(CacheKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the ArrayNodes from the in-memory local cache filtered by a specified enum that follows the CacheKeyEnum interface.
getCacheSubKeySnapshotStream(Function<? super JsonNode, ? extends V>, CacheKeyEnum, CacheSubKeyEnum...) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns WPCacheKeySnapshot instances extracted from the in-memory local cache filtered by a specified cache key.
getCaption() - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadBuilder
Returns the configured caption, or null if unset.
getCategories() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured category IDs, or null if unset.
getCategoryCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique categories from the in-memory local cache.
getClassListStream(Predicate<? super String>) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns class list elements from the in-memory local cache that match the provided filter.
getClassListStream(ClassMarkerEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns class list elements from the in-memory local cache that match the provided class marker enum.
getClassValueCount(ClassValueKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique class values from the in-memory local cache.
getClassValueStream(ClassValueKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the ArrayNodes from the in-memory local cache filtered by a specified enum that follows the ClassValueKeyEnum interface.
getCleanCategories() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns unique categories from the in-memory local cache.
getCleanTags() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns unique tags from the in-memory local cache.
getCommentStatus() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured comment status, or null if unset.
getContent() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured content, or null if unset.
getContentCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique content from the in-memory local cache.
getContents() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns WPCacheKeySnapshot instances extracted from the in-memory local cache filtered by the cache key WPCacheKey.
getDescription() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured taxonomy description, or null if unset.
getDescription() - Method in class net.ygbstudio.powerwp4j.builders.WPMediaPayloadBuilder
Returns the configured description, or null if unset.
getExcerpt() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured excerpt, or null if unset.
getExcerptCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique excerpts from the in-memory local cache.
getExcerpts() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns WPCacheKeySnapshot instances extracted from the in-memory local cache filtered by the cache key WPCacheKey enum and containing the "rendered" and "protected" represented by the WPCacheSubKey enum.
getFeaturedMedia() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured featured media ID, or null if unset.
getGuidCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique GUIDs from the in-memory local cache.
getGuids() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns WPCacheKeySnapshot instances extracted from the in-memory local cache filtered by the cache key WPCacheKey.GUID enum and containing the "rendered" represented by the WPCacheSubKey enum.
getLinkCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique links from the in-memory local cache.
getLinks() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns unique links from the in-memory local cache.
getMapper() - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Returns the configured ObjectMapper instance that is reused throughout the application.
getName() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured taxonomy name, or null if unset.
getPayloadNode() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Returns the payload node object used to build the JSON payload.
getPost(long) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Fetches a single post by its ID.
getPostCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique posts from the in-memory local cache.
getPropertiesFromResources(String) - Static method in class net.ygbstudio.powerwp4j.utils.Helpers
Loads properties from a specified property file located in the resources' directory.
getRawCategories() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns unique categories as found in the in-memory local cache.
getRawTags() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns unique tags as found in the in-memory local cache.
getSlug() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured slug, or null if unset.
getSlugCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique slugs from the in-memory local cache.
getSlugs() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns unique slugs from the in-memory local cache.
getStatus() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured post status, or null if unset.
getTagCount() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns the count of unique tags from the in-memory local cache.
getTags() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured tag IDs, or null if unset.
getTitle() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
Returns the configured title, or null if unset.
getTreeNode(File) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Reads a JSON file from the filesystem and parses it into a JsonNode.
getTreeNode(String) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Parses a JSON string into a JsonNode.
groupByKey() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassGroup
Returns the value of the groupByKey record component.
groupClassMarkerByPostId(UnaryOperator<String>) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Groups class markers by post ID.
groupedValues() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassGroup
Returns the value of the groupedValues record component.
groupPostIdsByClassMarker(ClassMarkerEnum, ClassValueKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Groups post IDs by class markers and maps them to their corresponding class values.
guid() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the guid record component.
GUID - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Global unique identifier.

H

hashCode() - Method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPCacheKeySnapshot
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassGroup
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPRendered
Returns a hash code value for this object.
hashCode() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns a hash code value for this object.
Helpers - Class in net.ygbstudio.powerwp4j.utils
Utility class for reusable logic in the project.
HttpRequestService - Class in net.ygbstudio.powerwp4j.services
HttpRequestService is a utility class for interacting with the WordPress REST API and provide convenience methods for common flows in the library.

I

id() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the id record component.
ID - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Post ID.
InvalidApiUrlException - Exception Class in net.ygbstudio.powerwp4j.exceptions
Exception thrown when an invalid API URL is provided and any of the internal methods of PowerWP4j detect a URISyntaxException.
InvalidApiUrlException(String) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.InvalidApiUrlException
Creates a new invalid API URL exception with the given message.
InvalidApiUrlException(String, URISyntaxException) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.InvalidApiUrlException
Creates a new invalid API URL exception with the given message and cause.
isInEnum(Class<T>, Function<? super T, ? extends R>, Predicate<? super R>) - Static method in class net.ygbstudio.powerwp4j.utils.Helpers
Checks if any enum constant's transformed value matches a given condition.

J

joinFields(URLFieldsEnum, URLFieldsEnum...) - Method in interface net.ygbstudio.powerwp4j.base.extension.enums.URLFieldsEnum
Joins the given fields into a single string, separated by commas.
joinQueryParams(Map<E, String>) - Static method in interface net.ygbstudio.powerwp4j.base.extension.enums.QueryParamEnum
This method helps you join a map of query parameters into a string that can be used as a query string.
JSON_CONTENT_TYPE - Static variable in class net.ygbstudio.powerwp4j.services.HttpRequestService
MIME type used for JSON requests and responses.
jsonReader(Reader, Class<T>) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Reads a JSON string from a Reader and deserializes it into an object of the specified class.
JsonSupport - Class in net.ygbstudio.powerwp4j.utils
JsonSupport provides JSON serialization and deserialization support using Jackson.

K

key() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Returns the value of the key record component.

L

lastUpdated() - Method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Returns the value of the lastUpdated record component.
link() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the link record component.
LINK - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Permalink URL.
LINK - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
linkProcessor(List<String>, BiFunction<HttpClient, String, CompletableFuture<R>>, Predicate<? super R>, Collector<? super R, R, R>) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Processes a list of links using a client function and returns a result artifact.
linkProcessor(List<String>, BiFunction<HttpClient, String, CompletableFuture<R>>, Predicate<? super R>, Collector<? super R, R, R>, Predicate<? super R>, TimeUnit, long, int, Supplier<String>) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Processes a list of links using a client function and returns a result artifact.
loadLocalCache(Path) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Loads the local cache file from the filesystem.

M

makeRequestURL(String, Map<E, String>, WPRestPath) - Static method in class net.ygbstudio.powerwp4j.services.HttpRequestService
Creates a request URL for the WordPress REST API.
mapWPClassId(UnaryOperator<String>, ClassMarkerEnum, ClassValueKeyEnum) - Method in class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Returns WPClassMapping instances extracted from the in-memory local cache filtered by the class marker TaxonomyMarker.TAG and the class value TaxonomyValues.TAGS.
MEDIA - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
MediaUploadException - Exception Class in net.ygbstudio.powerwp4j.exceptions
Exception thrown when there is an error during or before a media upload procedure.
MediaUploadException(String) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.MediaUploadException
Creates a new media upload exception with the given message.
MediaUploadException(Supplier<String>) - Constructor for exception class net.ygbstudio.powerwp4j.exceptions.MediaUploadException
Creates a new media upload exception with a lazily computed message.
meta() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the meta record component.
modified() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the modified record component.
modifiedGmt() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the modifiedGmt record component.

N

name - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Taxonomy name for taxonomy payloads.
name(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the name.
net.ygbstudio.powerwp4j.base.extension.builders - package net.ygbstudio.powerwp4j.base.extension.builders
 
net.ygbstudio.powerwp4j.base.extension.enums - package net.ygbstudio.powerwp4j.base.extension.enums
 
net.ygbstudio.powerwp4j.builders - package net.ygbstudio.powerwp4j.builders
 
net.ygbstudio.powerwp4j.engine - package net.ygbstudio.powerwp4j.engine
 
net.ygbstudio.powerwp4j.exceptions - package net.ygbstudio.powerwp4j.exceptions
 
net.ygbstudio.powerwp4j.models.entities - package net.ygbstudio.powerwp4j.models.entities
 
net.ygbstudio.powerwp4j.models.schema - package net.ygbstudio.powerwp4j.models.schema
 
net.ygbstudio.powerwp4j.models.taxonomies - package net.ygbstudio.powerwp4j.models.taxonomies
 
net.ygbstudio.powerwp4j.services - package net.ygbstudio.powerwp4j.services
 
net.ygbstudio.powerwp4j.utils - package net.ygbstudio.powerwp4j.utils
 
net.ygbstudio.powerwp4j.utils.functional - package net.ygbstudio.powerwp4j.utils.functional
 

O

of(WPSiteInfo) - Static method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Creates a new instance of WPRestClient using the provided WPSiteInfo.
OPEN - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCommentStatus
 

P

PAGE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPQueryParam
 
password - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Password for password-protected content.
password(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the password.
payloadNode - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Backing JSON object used to assemble the payload.
PENDING - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
 
PER_PAGE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPQueryParam
 
PHOTOS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
pingStatus() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the pingStatus record component.
POST - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPPostType
 
POST - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Post taxonomy marker.
postCreate(String, String, String, JsonNode, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Creates a new post in the WordPress site using the REST API.
postDelete(String, String, String, long, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Deletes a post from the WordPress site using the REST API.
PostFormatEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
Interface for post format enums that provide a unified type for addition of custom and built-in formats.
postGet(String, String, String, long, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Fetches a single post by its ID from the WordPress site using the REST API.
POSTS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
PostStatusEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
Interface for post status enums that provide a unified type for addition of custom post statuses.
PostTypeEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
Interface for post type enums that provide a unified type for addition of custom and built-in types.
PRIVATE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
 
PROTECTED - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheSubKey
 
protectedContent() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPRendered
Returns the value of the protectedContent record component.
PUBLISH - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
 

Q

QueryParamEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
QueryParamEnum is an interface that promotes a unified type for query parameters and a value() method to ensure consistency with the design practices of the project.
QUOTE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 

R

readJsonFs(File, Class<T>) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Reads a JSON file from the filesystem and deserializes it into an object of the specified class.
readValueFromJson(String, Class<T>) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Deserializes a JSON string into an object of the specified class.
rendered() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPRendered
Returns the value of the rendered record component.
RENDERED - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheSubKey
 
RestClientService - Class in net.ygbstudio.powerwp4j.services
The RestClientService class provides methods for interacting with the WordPress REST API for creating, reading, updating, and deleting posts, pages, and other entities.
RestPathEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
RestPathEnum is an interface that promotes unified type for rest paths to ensure consistency with the design practices of the project.

S

self() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder
Returns the current instance of the payload builder.
self() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Returns the current instance of the payload builder.
self() - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Returns the current instance of the payload builder.
self() - Method in class net.ygbstudio.powerwp4j.builders.WPBasicPayloadBuilder
 
setPayloadNode(ObjectNode) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadNodeBuilder
Sets the payload node object used to build the JSON payload.
slug - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
URL slug for the payload.
slug() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the slug record component.
slug(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the slug.
slug(String) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the slug.
SLUG - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
URL slug.
specialCharCleanJoin(String, String) - Static method in class net.ygbstudio.powerwp4j.utils.Helpers
Cleans a string by removing special characters and underscores and joining the remaining words with a delimiter.
STANDARD - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
status - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
WordPress post status value.
status() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the status record component.
status(PostStatusEnum) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the post status.
status(PostStatusEnum) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the post status.
STATUS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Post status.
STATUS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
STATUS - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Status taxonomy marker.
sticky - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Whether the post is sticky.
sticky() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the sticky record component.
sticky(boolean) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the sticky flag.
sticky(Boolean) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the sticky status.
STICKY - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Sticky flag.

T

TAG - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Tag taxonomy marker.
tags - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Tag IDs associated with the payload.
tags() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the tags record component.
tags(List<Integer>) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the tags.
tags(List<T>) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the tags.
tags(Set<WPClassMapping<T, U>>) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the tags using a set of WPClassMapping objects.
TAGS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
TAGS - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyValues
Tag term IDs.
TaxonomyMarker - Enum Class in net.ygbstudio.powerwp4j.models.taxonomies
Enum class for the WordPress cache taxonomy key markers.
TaxonomyValues - Enum Class in net.ygbstudio.powerwp4j.models.taxonomies
Enum class for the WordPress cache taxonomy value representation.
template() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the template record component.
testingOf(WPSiteInfo, boolean) - Static method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Creates a new instance of WPRestClient using the provided WPSiteInfo.
TIMESTAMP - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPQueryParam
 
title - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Post title.
title() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the title record component.
title(String) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the title.
title(String) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the title.
TITLE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Post title.
toJsonString(Object) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Serializes an object into a JSON string.
toNumberList(List<WPClassMapping<T, U>>) - Static method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Converts a list of WPClassMapping with numeric values to a set of the same numeric type.
toNumberSet(Set<WPClassMapping<T, U>>) - Static method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Converts a set of WPClassMapping with numeric values to a set of the same numeric type.
toString() - Method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPCacheKeySnapshot
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassGroup
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPRendered
Returns a string representation of this record class.
toString() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns a string representation of this record class.
totalPages() - Method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Returns the value of the totalPages record component.
totalPosts() - Method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Returns the value of the totalPosts record component.
TRASH - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
 
Trigger - Interface in net.ygbstudio.powerwp4j.utils.functional
Interface for representing a trigger function that can be activated lazily in context were code reuse is desired and enforced.
TriggerCallable<R> - Interface in net.ygbstudio.powerwp4j.utils.functional
TriggerCallable is a functional interface that represents a callable that can be triggered multiple times and returns a result of type R.
type - Variable in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
WordPress post type value.
type() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPPost
Returns the value of the type record component.
type(PostTypeEnum) - Method in class net.ygbstudio.powerwp4j.base.extension.builders.AbstractPayloadBuilder
Sets the post type.
type(PostTypeEnum) - Method in class net.ygbstudio.powerwp4j.builders.WPPayloadNodeBuilder
Sets the post type.
TYPE - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Post type.
TYPE - Enum constant in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Type taxonomy marker.
TypedTrigger<T> - Interface in net.ygbstudio.powerwp4j.utils.functional
Typed variant of the Trigger interface for representing an action that can be activated at a later point in the program with a specific argument supplied to a function to be executed.

U

updateCacheMeta(WPSiteInfo, Path, boolean) - Static method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Updates the cache metadata by making a request to the WordPress REST API and returns an optional WPCacheMeta object.
uploadMedia(String, String, String, Path, JsonNode, boolean) - Static method in class net.ygbstudio.powerwp4j.services.RestClientService
Uploads a media file to the WordPress site using the REST API.
uploadMedia(Path) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Uploads a media file to the WordPress site using the REST API.
uploadMedia(Path, JsonNode) - Method in class net.ygbstudio.powerwp4j.engine.WPRestClient
Uploads a media file to the WordPress site using the REST API and attaches a payload to the media file.
URLFieldsEnum - Interface in net.ygbstudio.powerwp4j.base.extension.enums
An interface for enum types that represent fields that can be used in a URL.
USERS - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 

V

value() - Method in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
 
value() - Method in interface net.ygbstudio.powerwp4j.base.extension.enums.FriendlyEnum
Returns the value of the enum constant, which is the actual string to be used in the API.
value() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Returns the value of the value record component.
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheSubKey
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPCommentStatus
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPPostType
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPQueryParam
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
 
value() - Method in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyValues
 
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheSubKey
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPCommentStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPPostType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPQueryParam
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyValues
Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheKey
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPCacheSubKey
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPCommentStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPPathField
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPPostType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPQueryParam
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPRestPath
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.schema.WPStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyMarker
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.ygbstudio.powerwp4j.models.taxonomies.TaxonomyValues
Returns an array containing the constants of this enum class, in the order they are declared.
VIDEO - Enum constant in enum class net.ygbstudio.powerwp4j.models.schema.WPFormat
 

W

WP_APPLICATION_PASS_ENV - Enum constant in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
WP_APP_PASS environment variable.
WP_APPLICATION_PASS_PROP - Enum constant in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
wp.appPass property key.
WP_FULLY_QUALIFIED_DOMAIN_NAME_ENV - Enum constant in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
WP_FQDN environment variable.
WP_FULLY_QUALIFIED_DOMAIN_NAME_PROP - Enum constant in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
wp.fqdn property key.
WP_USER_ENV - Enum constant in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
WP_USER environment variable.
WP_USER_PROP - Enum constant in enum class net.ygbstudio.powerwp4j.base.extension.enums.EnvironmentScope
wp.user property key.
wpAppPass() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns the value of the wpAppPass record component.
WPBasicPayloadBuilder - Class in net.ygbstudio.powerwp4j.builders
Basic payload builder for WordPress REST Payloads.
WPCacheAnalyzer - Class in net.ygbstudio.powerwp4j.engine
WPCacheAnalyzer is a class that provides methods for analyzing the local WordPress cache.
WPCacheAnalyzer() - Constructor for class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Creates an analyzer without loading a cache yet.
WPCacheAnalyzer(Path) - Constructor for class net.ygbstudio.powerwp4j.engine.WPCacheAnalyzer
Creates an analyzer and loads the cache from the given path.
WPCacheKey - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enumeration of possible cache keys for the WordPress REST API cache.
WPCacheKeySnapshot<V> - Record Class in net.ygbstudio.powerwp4j.models.entities
WPCacheKeySnapshot is a record that represents a snapshot of a cache key and its subkeys.
WPCacheKeySnapshot(CacheKeyEnum, Map<CacheSubKeyEnum, V>) - Constructor for record class net.ygbstudio.powerwp4j.models.entities.WPCacheKeySnapshot
Creates an instance of a WPCacheKeySnapshot record class.
WPCacheManager - Class in net.ygbstudio.powerwp4j.engine
WPCacheManager is the main class for interacting with a WordPress site.
WPCacheManager(String, String, String) - Constructor for class net.ygbstudio.powerwp4j.engine.WPCacheManager
Initializes a new instance of the WPCacheManager class.
WPCacheManager(String, String, String, Path) - Constructor for class net.ygbstudio.powerwp4j.engine.WPCacheManager
Initializes a new instance of the WPCacheManager class.
WPCacheManager(WPSiteInfo) - Constructor for class net.ygbstudio.powerwp4j.engine.WPCacheManager
Initializes a new instance of the WPCacheManager class using the provided WPSiteInfo object.
WPCacheManager(WPSiteInfo, Path) - Constructor for class net.ygbstudio.powerwp4j.engine.WPCacheManager
Initializes a new instance of the WPCacheManager class using the provided WPSiteInfo object and an optional cache path.
WPCacheMeta - Record Class in net.ygbstudio.powerwp4j.engine
Metadata for the cache file.
WPCacheMeta(long, long, LocalDate) - Constructor for record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Creates an instance of a WPCacheMeta record class.
WPCacheSubKey - Enum Class in net.ygbstudio.powerwp4j.models.schema
 
WPClassGroup<T,U> - Record Class in net.ygbstudio.powerwp4j.models.entities
A record that represents a group of values grouped by a key.
WPClassGroup(T, Set<U>) - Constructor for record class net.ygbstudio.powerwp4j.models.entities.WPClassGroup
Creates an instance of a WPClassGroup record class.
WPClassMapping<K,V> - Record Class in net.ygbstudio.powerwp4j.models.entities
Represents a mapping between a WordPress API class ID and a taxonomy value.
WPClassMapping(K, V) - Constructor for record class net.ygbstudio.powerwp4j.models.entities.WPClassMapping
Creates an instance of a WPClassMapping record class.
WPCommentStatus - Enum Class in net.ygbstudio.powerwp4j.models.schema
 
WPFormat - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enum class that represents formats in WordPress.
WPMediaPayloadBuilder - Class in net.ygbstudio.powerwp4j.builders
Builder for WordPress media attachment payloads.
WPMediaPayloadNodeBuilder - Class in net.ygbstudio.powerwp4j.builders
WPMediaPayloadNodeBuilder is a builder class for constructing a WordPress media payload.
WPPathField - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enum representing the fields that can be requested in a WordPress REST API path.
WPPayloadNodeBuilder - Class in net.ygbstudio.powerwp4j.builders
This class is a specialized builder for constructing JSON payloads in the format used by the WordPress REST API.
WPPost - Record Class in net.ygbstudio.powerwp4j.models.entities
A record representing a WordPress Post.
WPPost(long, LocalDateTime, LocalDateTime, WPRendered, LocalDateTime, LocalDateTime, String, String, String, String, WPRendered, WPRendered, WPRendered, long, long, String, String, boolean, String, String, Map<String, Object>, List<? extends Number>, List<? extends Number>) - Constructor for record class net.ygbstudio.powerwp4j.models.entities.WPPost
Creates an instance of a WPPost record class.
WPPostType - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enum representing different types of WordPress posts.
WPQueryParam - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enumeration of standard WordPress query parameters.
WPRendered - Record Class in net.ygbstudio.powerwp4j.models.entities
A record representing a rendered WordPress field (e.g. title, content, excerpt).
WPRendered(String, Boolean) - Constructor for record class net.ygbstudio.powerwp4j.models.entities.WPRendered
Creates an instance of a WPRendered record class.
WPRestClient - Class in net.ygbstudio.powerwp4j.engine
This class provides a facade for accessing the WordPress REST API.
WPRestClient(WPSiteInfo) - Constructor for class net.ygbstudio.powerwp4j.engine.WPRestClient
 
WPRestClient(WPSiteInfo, boolean) - Constructor for class net.ygbstudio.powerwp4j.engine.WPRestClient
 
WPRestPath - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enum representing various API endpoints and query parameters for WordPress REST API.
WPSiteInfo - Record Class in net.ygbstudio.powerwp4j.models.entities
A record that represents basic site information required to interact with a WordPress site.
WPSiteInfo(String, String, String) - Constructor for record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Creates an instance of a WPSiteInfo record class.
WPStatus - Enum Class in net.ygbstudio.powerwp4j.models.schema
Enum class that represents statuses in WordPress.
wpUser() - Method in class net.ygbstudio.powerwp4j.engine.WPCacheManager
Returns the user name for the WordPress site.
wpUser() - Method in record class net.ygbstudio.powerwp4j.models.entities.WPSiteInfo
Returns the value of the wpUser record component.
writeCacheMetadata(Path, WPCacheMeta) - Static method in record class net.ygbstudio.powerwp4j.engine.WPCacheMeta
Writes the WPCacheMeta object to the metadata file at the specified path in the local file system.
writeJsonFs(File, T) - Static method in class net.ygbstudio.powerwp4j.utils.JsonSupport
Serializes an object and writes it to a JSON file on the filesystem.
writePropertyFile(String, List<String>, List<String>, String) - Static method in class net.ygbstudio.powerwp4j.utils.Helpers
Writes properties to a specified property file located in the resources directory, updating existing properties or adding new ones.

Z

zip(List<? extends K>, List<? extends V>) - Static method in class net.ygbstudio.powerwp4j.utils.Helpers
Zips two lists into a stream of map entries, pairing elements from both lists by their indices.
A B C D E F G H I J K L M N O P Q R S T U V W Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form