com.urbanairship.api.push.model.notification.actions

Class TagActionData

java.lang.Object

com.urbanairship.api.common.model.APIModelObject

com.urbanairship.api.push.model.PushModelObject

com.urbanairship.api.push.model.notification.actions.TagActionData

public abstract class TagActionData
extends PushModelObject

Represents tags specified in an 'add tags' or 'remove tags' action. Modeled after the 'Optional' type, this class represents either a single tag (a string) or a set of tags.

Constructor Summary

Constructors

Constructor and Description
TagActionData()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getSingleTag() Returns the tag represented, if this object was constructed with single(String), otherwise throw an exception.
abstract java.util.Set<java.lang.String>	getTagSet() Returns the tags represented, if this object was constructed with set(Set), otherwise throw an exception.
abstract boolean	isSingle() When true, this object represents a single tag (and calling getSingleTag() will succeed).
static TagActionData	set(java.util.Set<java.lang.String> tags) Represents a set of tags.
static TagActionData	single(java.lang.String tag) Represents a single tag.

Methods inherited from class com.urbanairship.api.push.model.PushModelObject

toJSON

Methods inherited from class com.urbanairship.api.common.model.APIModelObject

toJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

TagActionData

public TagActionData()

Method Detail

single

public static TagActionData single(java.lang.String tag)

Represents a single tag.

Parameters:

tag - String tag

Returns:

TagActionData

set

public static TagActionData set(java.util.Set<java.lang.String> tags)

Represents a set of tags.

Parameters:

tags - Set of tags

Returns:

TagActionData

isSingle

public abstract boolean isSingle()

When true, this object represents a single tag (and calling getSingleTag() will succeed). Otherwise, this represents a set of tags (and calling getTagSet() will succeed).

Returns:

boolean

getSingleTag

public abstract java.lang.String getSingleTag()

Returns the tag represented, if this object was constructed with single(String), otherwise throw an exception.

Returns:

String

getTagSet

public abstract java.util.Set<java.lang.String> getTagSet()

Returns the tags represented, if this object was constructed with set(Set), otherwise throw an exception.

Returns:

Set of tags