com.sdl.context.api

Interface ContextMap<A extends Aspect>

Type Parameters:

A - an aspect

All Superinterfaces:

Serializable

public interface ContextMap<A extends Aspect>
extends Serializable

A context map. A collection of aspects which define contextual properties.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String aspectName) Test whether the context map includes an aspect with the specified name.
Object	get(ContextPropertyName propertyName) Get context map value from context property name.
A	get(String aspectName) Get aspect with the specified name, returning null if aspect does not exist.
boolean	isEmpty() Is the context map empty?
Set<String>	keySet() Get aspect names included in this context map.
int	size() Get the number of aspects in this context map.

Method Detail

size

int size()

Get the number of aspects in this context map.

Returns:

number of aspects in this context map.

get

A get(String aspectName)

Get aspect with the specified name, returning null if aspect does not exist.

Parameters:

aspectName - aspect name

Returns:

aspect with specified name or null

isEmpty

boolean isEmpty()

Is the context map empty?

Returns:

whether the context map is empty

containsKey

boolean containsKey(String aspectName)

Test whether the context map includes an aspect with the specified name.

Parameters:

aspectName - aspect name

Returns:

whether named aspect is in context map

get

Object get(ContextPropertyName propertyName)

Get context map value from context property name.

Parameters:

propertyName - property name

Returns:

context map value

keySet

Set<String> keySet()

Get aspect names included in this context map.

Returns:

set of aspect names included in this context map