com.contentful.java.cma.model

Class CMAEntry

java.lang.Object

com.contentful.java.cma.model.CMAResource

com.contentful.java.cma.model.CMAEntry

public class CMAEntry
extends CMAResource

Represents a resource of type Entry.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CMAEntry.Localized Localize all fields with a given locale.

Field Summary

Fields

Modifier and Type	Field and Description
CMAMetadata	metadata

Constructor Summary

Constructors

Constructor and Description
CMAEntry() Create an entry, filling the system property

Method Summary

Modifier and Type	Method and Description
<T> T	getField(String key, String locale) Return a specific localized field.
LinkedHashMap<String,LinkedHashMap<String,Object>>	getFields()
CMAMetadata	getMetadata()
CMAEntry.Localized	localize(String locale) Manipulate fields with the same locale.
CMAEntry	setEnvironmentId(String environmentId) Convenience: Update the environment id, without going through CMAResource.getSystem().
CMAEntry	setField(String key, String locale, Object value) Creates a new field with the given value.
CMAEntry	setFields(LinkedHashMap<String,LinkedHashMap<String,Object>> fields) Sets a map of fields for this Entry.
CMAEntry	setId(String id) Convenience: Update the id of this entry without going through CMAResource.getSystem().
CMAEntry	setMetadata(CMAMetadata metadata) Sets the metadata for this entry.
CMAEntry	setSpaceId(String spaceId) Convenience: Update the space id of this entry without going through CMAResource.getSystem().
CMAEntry	setSystem(CMASystem system) Sets the system field.
CMAEntry	setVersion(Integer version) Convenience: Update the version of this entry without going through CMAResource.getSystem().
String	toString()

Methods inherited from class com.contentful.java.cma.model.CMAResource

getEnvironmentId, getId, getSpaceId, getSystem, getVersion, getVisibility, isArchived, isPublished, setVisibility

Methods inherited from class java.lang.Object

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

Field Detail

metadata

public CMAMetadata metadata

Constructor Detail

CMAEntry

public CMAEntry()

Create an entry, filling the system property

Method Detail

setSystem

public CMAEntry setSystem(CMASystem system)

Sets the system field.

Overrides:

setSystem in class CMAResource

Parameters:

system - sets the system property.

Returns:

this, as casted to a resource, for the ease of chaining.

setId

public CMAEntry setId(String id)

Convenience: Update the id of this entry without going through CMAResource.getSystem().

Overrides:

setId in class CMAResource

Parameters:

id - to be set.

Returns:

the calling instance for chaining.

setVersion

public CMAEntry setVersion(Integer version)

Convenience: Update the version of this entry without going through CMAResource.getSystem().

Overrides:

setVersion in class CMAResource

Parameters:

version - to be set.

Returns:

the calling instance for chaining.

setSpaceId

public CMAEntry setSpaceId(String spaceId)

Convenience: Update the space id of this entry without going through CMAResource.getSystem().

Overrides:

setSpaceId in class CMAResource

Parameters:

spaceId - to be set.

Returns:

the calling instance for chaining.

setEnvironmentId

public CMAEntry setEnvironmentId(String environmentId)

Convenience: Update the environment id, without going through CMAResource.getSystem().

Overrides:

setEnvironmentId in class CMAResource

Parameters:

environmentId - to be set.

Returns:

the calling instance for chaining.

setField

public CMAEntry setField(String key,
                         String locale,
                         Object value)

Creates a new field with the given value. If a field named key already exists it will be replaced.

Parameters:

key - field key

locale - locale

value - value

Returns:

this CMAEntry

getField

public <T> T getField(String key,
                      String locale)

Return a specific localized field.

Type Parameters:

T - the type of the return value

Parameters:

key - the key of the field

locale - the locale of the key

Returns:

the value requested or null, if something (fields, key, locale) was not found.

getFields

public LinkedHashMap<String,LinkedHashMap<String,Object>> getFields()

Returns:

a map of fields for this Entry.

getMetadata

public CMAMetadata getMetadata()

setMetadata

public CMAEntry setMetadata(CMAMetadata metadata)

Sets the metadata for this entry.

Parameters:

metadata - The CMAMetadata instance to associate with this entry.

Returns:

This CMAEntry instance for method chaining.

setFields

public CMAEntry setFields(LinkedHashMap<String,LinkedHashMap<String,Object>> fields)

Sets a map of fields for this Entry.

Parameters:

fields - the fields to be set

Returns:

this CMAEntry instance

localize

public CMAEntry.Localized localize(String locale)

Manipulate fields with the same locale.

Parameters:

locale - the locale to be used for accessing fields.

Returns:

an instance of CMAEntry.Localized to be used for setting subsequent fields.

toString

public String toString()

Overrides:

toString in class CMAResource

Returns:

a human readable string, representing the object.