com.sdl.context.api

Interface Aspect

All Superinterfaces:

Serializable

public interface Aspect
extends Serializable

An aspect. The way in which a property may vary depending on how it is viewed. For example: device, os, browser, proxy. This interface contains the collection of properties available on each aspect.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Returns true if a property with the specified key exists in the Aspect.
Object	get(String key) Returns the value of the property (with the specified key).
AspectDefinition	getDefinition() Get aspect definition.
ContextProperty	getProperty(String name) Gets a property.
boolean	isEmpty() Returns true if there are no properties in the Aspect.
Set<String>	keySet() Returns the keys of all the property keys in this Aspect.
int	size() Returns the number of properties in the Aspect.

Method Detail

getProperty

ContextProperty getProperty(String name)

Gets a property. This method can be used to determine a particular context property, given its local property name.

Parameters:

name - the local property name

Returns:

the context property

size

int size()

Returns the number of properties in the Aspect.

Returns:

the number of properties in the Aspect.

isEmpty

boolean isEmpty()

Returns true if there are no properties in the Aspect.

Returns:

true if there are no properties in the Aspect

containsKey

boolean containsKey(String key)

Returns true if a property with the specified key exists in the Aspect.

Parameters:

key - the property key (e.g. 'model')

Returns:

true if a property with the specified key exists in the Aspect

get

Object get(String key)

Returns the value of the property (with the specified key).

Parameters:

key - the property key (e.g. 'model')

Returns:

the value of the property

keySet

Set<String> keySet()

Returns the keys of all the property keys in this Aspect.

Returns:

the keys of all the property keys in this Aspect.

getDefinition

AspectDefinition getDefinition()

Get aspect definition.

Returns:

AspectDefinition instance