org.apache.streams.pojo.json.verbs

Class Consume

java.lang.Object

org.apache.streams.pojo.json.Activity

org.apache.streams.pojo.json.verbs.Consume

All Implemented Interfaces:

Serializable

@Generated(value="org.jsonschema2pojo")
public class Consume
extends Activity

Consume

Indicates that the actor has consumed the object. The specific meaning is dependent largely on the object's type. For instance, an actor may "consume" an audio object, indicating that the actor has listened to it; or an actor may "consume" a book, indicating that the book has been read. As such, the "consume" verb is a more generic form of other more specific verbs such as "read" and "play".

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Consume()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
String	getTitle() Natural-language title or headline for the activity encoded as a single JSON String containing HTML markup.
String	getVerb() verb
int	hashCode()
void	setAdditionalProperty(String name, Object value)
void	setTitle(String title) Natural-language title or headline for the activity encoded as a single JSON String containing HTML markup.
void	setVerb(String verb) verb
String	toString()
Consume	withAdditionalProperty(String name, Object value)
Consume	withTitle(String title)
Consume	withVerb(String verb)

Methods inherited from class org.apache.streams.pojo.json.Activity

getActor, getContent, getGenerator, getIcon, getId, getLinks, getObject, getProvider, getPublished, getTarget, getUpdated, getUrl, setActor, setContent, setGenerator, setIcon, setId, setLinks, setObject, setProvider, setPublished, setTarget, setUpdated, setUrl, withActor, withContent, withGenerator, withIcon, withId, withLinks, withObject, withProvider, withPublished, withTarget, withUpdated, withUrl

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Consume

public Consume()

Method Detail

getVerb

@BeanProperty(value="verb")
public String getVerb()

Description copied from class: Activity

verb

Identifies the action that the activity describes. An activity MUST contain a verb property whose value is a JSON String that is non-empty and matches either the "isegment-nz-nc" or the "IRI" production in [RFC3987]. Note that the use of a relative reference other than a simple name is not allowed. (Required)

Overrides:

getVerb in class Activity

Returns:

The verb

setVerb

@BeanProperty(value="verb")
public void setVerb(String verb)

Description copied from class: Activity

verb

Identifies the action that the activity describes. An activity MUST contain a verb property whose value is a JSON String that is non-empty and matches either the "isegment-nz-nc" or the "IRI" production in [RFC3987]. Note that the use of a relative reference other than a simple name is not allowed. (Required)

Overrides:

setVerb in class Activity

Parameters:

verb - The verb

withVerb

public Consume withVerb(String verb)

Overrides:

withVerb in class Activity

getTitle

@BeanProperty(value="title")
public String getTitle()

Description copied from class: Activity

Natural-language title or headline for the activity encoded as a single JSON String containing HTML markup. An activity MAY contain a title property

Overrides:

getTitle in class Activity

Returns:

The title

setTitle

@BeanProperty(value="title")
public void setTitle(String title)

Description copied from class: Activity

Natural-language title or headline for the activity encoded as a single JSON String containing HTML markup. An activity MAY contain a title property

Overrides:

setTitle in class Activity

Parameters:

title - The title

withTitle

public Consume withTitle(String title)

Overrides:

withTitle in class Activity

toString

public String toString()

Overrides:

toString in class Activity

getAdditionalProperties

@BeanProperty(name="*")
public Map<String,Object> getAdditionalProperties()

Overrides:

getAdditionalProperties in class Activity

setAdditionalProperty

@BeanProperty(name="*")
public void setAdditionalProperty(String name,
                                                          Object value)

Overrides:

setAdditionalProperty in class Activity

withAdditionalProperty

public Consume withAdditionalProperty(String name,
                                      Object value)

Overrides:

withAdditionalProperty in class Activity

hashCode

public int hashCode()

Overrides:

hashCode in class Activity

equals

public boolean equals(Object other)

Overrides:

equals in class Activity