Package net.ygbstudio.powerwp4j.builders

Class WPMediaPayloadBuilder

java.lang.Object

net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder<WPMediaPayloadBuilder>

net.ygbstudio.powerwp4j.builders.WPMediaPayloadBuilder

public final class WPMediaPayloadBuilder
extends AbstractMediaPayloadBuilder<WPMediaPayloadBuilder>

Builder for WordPress media attachment payloads. Inherits all methods from its abstract superclass to provide a chainable pattern for building media attachment payloads.

If you need to use a builder for posts or taxonomies, use WPBasicPayloadBuilder.

Since:

0.1.0

See Also:

• AbstractMediaPayloadBuilder

Field Summary

Fields inherited from class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder

altText, caption, description

Method Summary

Modifier and Type	Method	Description
tools.jackson.databind.JsonNode	build()	Builds the media attachment payload as a JsonNode.
static @NotNull WPMediaPayloadBuilder	builder()	Creates a new instance of WPMediaPayloadBuilder.
String	getAltText()	Returns the configured alternative text, or null if unset.
String	getCaption()	Returns the configured caption, or null if unset.
String	getDescription()	Returns the configured description, or null if unset.

Methods inherited from class net.ygbstudio.powerwp4j.base.extension.builders.AbstractMediaPayloadBuilder

altText, caption, clear, description, self

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

@Contract(" -> new")
@NotNull
public static @NotNull WPMediaPayloadBuilder builder()

Creates a new instance of WPMediaPayloadBuilder.

Returns:

A new instance of WPMediaPayloadBuilder.

getAltText

public String getAltText()

Returns the configured alternative text, or null if unset.

Returns:

the configured alternative text, or null if unset.

getCaption

public String getCaption()

Returns the configured caption, or null if unset.

Returns:

the configured caption, or null if unset.

getDescription

public String getDescription()

Returns the configured description, or null if unset.

Returns:

the configured description, or null if unset.

build

public tools.jackson.databind.JsonNode build()

Description copied from class: AbstractMediaPayloadBuilder

Builds the media attachment payload as a JsonNode.

Specified by:

build in class AbstractMediaPayloadBuilder<WPMediaPayloadBuilder>

Returns:

JsonNode representing the media attachment payload.