org.intellimate.izou.sdk.frameworks.presence.provider

Class Presence

java.lang.Object

org.intellimate.izou.sdk.frameworks.presence.provider.Presence

public class Presence
extends Object

this class holds all important information about the Presence of the user

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	KNOWN_DESCRIPTOR
static String	LEVEL_DESCRIPTOR
static String	PRESENT_DESCRIPTOR
static String	STRICT_DESCRIPTOR

Constructor Summary

Constructors

Constructor and Description
Presence(PresenceIndicatorLevel level, boolean present, boolean strict, boolean known) returns a new Presence-Object

Method Summary

Modifier and Type	Method and Description
HashMap<String,Object>	export() exports the Presence to a HashMap
PresenceIndicatorLevel	getLevel() returns the (vague) level of the reliability of the data.
static Optional<Presence>	importPresence(ResourceModel resourceModel) imports (if no errors occurred) the Presence from the ResourceModel
boolean	isKnown() whether it is known that the user cause the Event
boolean	isPresent() whether it is present AND known
boolean	isStrict() whether it is strict (very high probability that the user is around)

Methods inherited from class java.lang.Object

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

Field Detail

LEVEL_DESCRIPTOR

public static final String LEVEL_DESCRIPTOR

See Also:

Constant Field Values

PRESENT_DESCRIPTOR

public static final String PRESENT_DESCRIPTOR

See Also:

Constant Field Values

STRICT_DESCRIPTOR

public static final String STRICT_DESCRIPTOR

See Also:

Constant Field Values

KNOWN_DESCRIPTOR

public static final String KNOWN_DESCRIPTOR

See Also:

Constant Field Values

Constructor Detail

Presence

public Presence(PresenceIndicatorLevel level,
                boolean present,
                boolean strict,
                boolean known)

returns a new Presence-Object

Parameters:

level - the level of the Presence (mostly used internally)

present - whether it is present

strict - whether it is strict

known - whether it is known that the user caused this

Method Detail

getLevel

public PresenceIndicatorLevel getLevel()

returns the (vague) level of the reliability of the data. Mostly used internally)

Returns:

the Level

isPresent

public boolean isPresent()

whether it is present AND known

Returns:

true if present

isStrict

public boolean isStrict()

whether it is strict (very high probability that the user is around)

Returns:

true if strict

isKnown

public boolean isKnown()

whether it is known that the user cause the Event

Returns:

true if known

export

public HashMap<String,Object> export()

exports the Presence to a HashMap

Returns:

the resulting HashMap

importPresence

public static Optional<Presence> importPresence(ResourceModel resourceModel)

imports (if no errors occurred) the Presence from the ResourceModel

Parameters:

resourceModel - the resourcemodel to import from

Returns:

the (optional) presence