kontent.ai.delivery

Class ContentItem

java.lang.Object

kontent.ai.delivery.ContentItem

public class ContentItem
extends java.lang.Object

Object model description of a single content item object.

See Also:

Kontent.ai API reference - Content item object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentItem.ContentItemBuilder

Constructor Summary

Constructors

Constructor and Description
ContentItem()
ContentItem(System system, java.util.Map<java.lang.String,Element> elements, kontent.ai.delivery.LinkedItemProvider linkedItemProvider, StronglyTypedContentItemConverter stronglyTypedContentItemConverter)

Method Summary

Modifier and Type	Method and Description
static ContentItem.ContentItemBuilder	builder()
protected boolean	canEqual(java.lang.Object other)
<T> T	castTo(java.lang.Class<T> tClass) Returns a new instance of T by mapping fields to elements in this content item.
java.lang.Object	castTo(java.lang.String contentItemSystemType) Returns a new instance by mapping fields to elements in this content item.
java.lang.Object	castToDefault() Returns a new instance by mapping fields to elements in this content item.
boolean	equals(java.lang.Object o)
java.util.List<Asset>	getAssets(java.lang.String codename) Convenience method to get the value of an Assets element without traversing the Elements map.
java.util.Map<java.lang.String,Element>	getElements() Content type elements in the content item.
ContentItem	getLinkedItem(java.lang.String codename) Convenience method to retrieve the ContentItem from linked items.
kontent.ai.delivery.LinkedItemProvider	getLinkedItemProvider()
java.lang.String	getString(java.lang.String codename) Convenience method to get the value of a Text or Rich text element without traversing the Elements map.
StronglyTypedContentItemConverter	getStronglyTypedContentItemConverter()
System	getSystem() System attributes of the content item.
int	hashCode()
void	setElements(java.util.Map<java.lang.String,Element> elements) Content type elements in the content item.
void	setSystem(System system) System attributes of the content item.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContentItem

public ContentItem()

ContentItem

public ContentItem(System system,
                   java.util.Map<java.lang.String,Element> elements,
                   kontent.ai.delivery.LinkedItemProvider linkedItemProvider,
                   StronglyTypedContentItemConverter stronglyTypedContentItemConverter)

Method Detail

setElements

public void setElements(java.util.Map<java.lang.String,Element> elements)

Content type elements in the content item. These are keyed by the codename of the element.

Note: The order of the Element objects might not match the order in the Kontent.ai UI.

Parameters:

elements - New value for this ContentItem's Element objects.

getString

public java.lang.String getString(java.lang.String codename)

Convenience method to get the value of a Text or Rich text element without traversing the Elements map.

Parameters:

codename - The element codename to retrieve the String rendering of from this ContentItem.

Returns:

The value of the element. Returns null if the element does not exist, or if it is not a TextElement or RichTextElement.

getAssets

public java.util.List<Asset> getAssets(java.lang.String codename)

Convenience method to get the value of an Assets element without traversing the Elements map.

Parameters:

codename - The element codename to get the Asset list of from this ContentItem.

Returns:

A list of Asset objects. Returns an empty collection if the element does not exist, or if it is not an AssetsElement.

getLinkedItem

public ContentItem getLinkedItem(java.lang.String codename)

Convenience method to retrieve the ContentItem from linked items.

Parameters:

codename - The ContentItem codename of the linked item.

Returns:

The ContentItem. Returns null if it was not included in the response.

castTo

public <T> T castTo(java.lang.Class<T> tClass)

Returns a new instance of T by mapping fields to elements in this content item. Element fields are mapped by automatically CamelCasing and checking for equality, unless otherwise annotated by an ElementMapping annotation. T must have a default constructor and have standard setter methods. When passing in Object.class, the type returned will be an instance of the class registered with the DeliveryClient that is annotated with ContentItemMapping that matches the System.type of this ContentItem (however still returned as type Object).

If Object is passed in, the StronglyTypedContentItemConverter will cast this ContentItem to a type that is mapped this ContentItem's System.type from a previous registration via the registration has been done, then this same instance of ContentItem will be returned. Invoking castToDefault() is the same as invoking this method with Object.

Type Parameters:

T - The type of class which will be returned.

Parameters:

tClass - The class which a new instance should be returned from using this ContentItem.

Returns:

An instance of T with data mapped from this ContentItem.

See Also:

DeliveryClient.registerType(Class), DeliveryClient.registerType(String, Class), ContentItemMapping, ElementMapping, StronglyTypedContentItemConverter

castToDefault

public java.lang.Object castToDefault()

Returns a new instance by mapping fields to elements in this content item. Element fields are mapped by automatically CamelCasing and checking for equality, unless otherwise annotated by an ElementMapping annotation. The type returned will be an instance of the class registered with the DeliveryClient that is annotated with ContentItemMapping that matches the System.type of this ContentItem (however still returned as type Object).

If no registration has been done, then this same instance of ContentItem will be returned.

Returns:

An instance with data mapped from this ContentItem.

See Also:

castTo(Class), DeliveryClient.registerType(Class), DeliveryClient.registerType(String, Class), ContentItemMapping, ElementMapping, StronglyTypedContentItemConverter

castTo

public java.lang.Object castTo(java.lang.String contentItemSystemType)

Returns a new instance by mapping fields to elements in this content item. Element fields are mapped by automatically CamelCasing and checking for equality, unless otherwise annotated by an ElementMapping annotation. The type returned will be an instance of the class registered with the DeliveryClient that that matches the System.type provided.

If no registration has been done, then this same instance of ContentItem will be returned.

Parameters:

contentItemSystemType - The contentItemSystemType to match this ContentItem too.

Returns:

An instance with data mapped from this ContentItem.

See Also:

castTo(Class), DeliveryClient.registerType(Class), DeliveryClient.registerType(String, Class), ContentItemMapping, ElementMapping, StronglyTypedContentItemConverter

builder

public static ContentItem.ContentItemBuilder builder()

getSystem

public System getSystem()

System attributes of the content item.

Returns:

The System attributes of this content item.

getElements

public java.util.Map<java.lang.String,Element> getElements()

Content type elements in the content item. These are keyed by the codename of the element.

Note: The order of the Element objects might not match the order in the Kontent.ai UI.

Returns:

Map of this ContentItem's Element objects.

getLinkedItemProvider

public kontent.ai.delivery.LinkedItemProvider getLinkedItemProvider()

getStronglyTypedContentItemConverter

public StronglyTypedContentItemConverter getStronglyTypedContentItemConverter()

setSystem

public void setSystem(System system)

System attributes of the content item.

Parameters:

system - New value for System attributes of this content item.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object