com.foreach.across.modules.webcms.domain.domain

Class WebCmsDomainContext

java.lang.Object

com.foreach.across.modules.webcms.domain.domain.WebCmsDomainContext

public class WebCmsDomainContext
extends Object

Represents a WebCmsDomain with its associated WebCmsDomainAware. Note that both the actual domain and its metadata can be null. A metadata instance is always optional (but strongly advised), a null domain represents the special no-domain context, in which case there can still be metadata available depending on your application setup.

If you want to initialize a context for no-domain, you should use the #noDomain(WebCmsDomainAware) factory methods.

Since:

0.0.3

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor and Description
WebCmsDomainContext(WebCmsDomain domain, Object metadata)

Method Summary

Modifier and Type	Method and Description
<T> T	getMetadata(Class<T> expectedType) Retrieve the domain metadata and coerce it to a the expected type.
boolean	hasMetadata()
boolean	holdsDomain()
boolean	holdsDomain(String domainKey) Check if the context holds the domain with the specified domain key.
boolean	isMetadataOfType(Class<?> expectedType) Check if the metadata is of a particular type.
boolean	isNoDomain()
static WebCmsDomainContext	noDomain()
static WebCmsDomainContext	noDomain(Object metadata)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsDomainContext

public WebCmsDomainContext(WebCmsDomain domain,
                           Object metadata)

Method Detail

noDomain

public static WebCmsDomainContext noDomain()

Returns:

context representing no-domain - without metadata

noDomain

public static WebCmsDomainContext noDomain(Object metadata)

Parameters:

metadata - to put on the context

Returns:

context representing no-domain holding the specified metadata

getMetadata

public <T> T getMetadata(Class<T> expectedType)

Retrieve the domain metadata and coerce it to a the expected type. A ClassCastException will be thrown if the metadata is not of the right type.

Type Parameters:

T - metadata type

Parameters:

expectedType - the metadata should have

Returns:

metadata cast as type

isMetadataOfType

public boolean isMetadataOfType(Class<?> expectedType)

Check if the metadata is of a particular type. If no metadata is set, this method will always return false.

Parameters:

expectedType - for the metadata

Returns:

true if metadata is of the actual type

hasMetadata

public boolean hasMetadata()

Returns:

true if metadata is configured

holdsDomain

public boolean holdsDomain()

Returns:

true if a domain is present

holdsDomain

public boolean holdsDomain(String domainKey)

Check if the context holds the domain with the specified domain key. If the domain key is null, this will check if no-domain is attached.

Parameters:

domainKey - to check for

Returns:

true if the attached domain has that key

isNoDomain

public boolean isNoDomain()

Returns:

true if no domain is present (opposite of holdsDomain())