com.contentful.java.cma.model

Class CMAEnvironment

java.lang.Object

com.contentful.java.cma.model.CMAResource

com.contentful.java.cma.model.CMAEnvironment

public class CMAEnvironment
extends CMAResource

Represents a resource of type environment.

Constructor Summary

Constructors

Constructor and Description
CMAEnvironment() Create a environment using the default types for the system property.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEnvironmentId() Override retrieval of the environment id here, since the id of this environment is it's id.
java.lang.String	getName()
CMAEnvironmentStatus	getStatus() Return the state of this environment
<T extends CMAResource> T	setEnvironmentId(java.lang.String environmentId) Convenience method for setting an environment id.
CMAEnvironment	setId(java.lang.String id) Sets the id of this environment.
CMAEnvironment	setName(java.lang.String name) Sets the name for this environment.
CMAEnvironment	setSystem(CMASystem system) Sets the system field.
CMAEnvironment	setVersion(java.lang.Integer version) Set the version of this environment.
java.lang.String	toString()

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

getId, getSpaceId, getSystem, getVersion, isArchived, isPublished, setSpaceId

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAEnvironment

public CMAEnvironment()

Create a environment using the default types for the system property.

Method Detail

setSystem

public CMAEnvironment 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.

getName

public java.lang.String getName()

Returns:

the name of this environment.

setName

public CMAEnvironment setName(java.lang.String name)

Sets the name for this environment.

Parameters:

name - the name of the environment to be set

Returns:

this CMAEnvironment instance.

setId

public CMAEnvironment setId(java.lang.String id)

Sets the id of this environment.

Overrides:

setId in class CMAResource

Parameters:

id - to be set.

Returns:

this instance for chaining.

getEnvironmentId

public java.lang.String getEnvironmentId()

Override retrieval of the environment id here, since the id of this environment is it's id.

Overrides:

getEnvironmentId in class CMAResource

Returns:

the ID of the Environment associated with this resource, Constants.DEFAULT_ENVIRONMENT if it does not exist.

setEnvironmentId

public <T extends CMAResource> T setEnvironmentId(java.lang.String environmentId)

Convenience method for setting an environment id.

Overrides:

setEnvironmentId in class CMAResource

Type Parameters:

T - An implementation of CMAResource, normally used for chaining setter methods.

Parameters:

environmentId - the id to be set.

Returns:

the calling CMAResource for chaining.

setVersion

public CMAEnvironment setVersion(java.lang.Integer version)

Set the version of this environment.

Overrides:

setVersion in class CMAResource

Parameters:

version - the version to be set.

Returns:

this environment instance for chaining.

getStatus

public CMAEnvironmentStatus getStatus()

Return the state of this environment

Returns:

one of CMAEnvironmentStatus to indicate the status of the environment.

toString

public java.lang.String toString()

Overrides:

toString in class CMAResource

Returns:

a human readable string, representing the object.