org.apache.streams.pojo.json

Class Collection

java.lang.Object

org.apache.streams.pojo.json.Collection

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Members

@Generated(value="org.jsonschema2pojo")
public class Collection
extends Object
implements Serializable

collection

A collection is a generic list of Objects of any object type. The objectType of each item in the collection MAY be omitted if the type of object can be established through context. The collection is used primarily as the root of an Activity Streams document, but can be used as the value of extension properties in a variety of situations.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Collection()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
List<Item>	getItems() An array containing a listing of Objects of any object type.
List<Object>	getLinks() Links between an this object and other resources as defined in Web Linking
Long	getTotalItems() Non-negative integer specifying the total number of activities within the stream.
String	getUrl() An IRI [RFC3987] referencing a JSON document containing the full listing of objects in the collection.
int	hashCode()
void	setAdditionalProperty(String name, Object value)
void	setItems(List<Item> items) An array containing a listing of Objects of any object type.
void	setLinks(List<Object> links) Links between an this object and other resources as defined in Web Linking
void	setTotalItems(Long totalItems) Non-negative integer specifying the total number of activities within the stream.
void	setUrl(String url) An IRI [RFC3987] referencing a JSON document containing the full listing of objects in the collection.
String	toString()
Collection	withAdditionalProperty(String name, Object value)
Collection	withItems(List<Item> items)
Collection	withLinks(List<Object> links)
Collection	withTotalItems(Long totalItems)
Collection	withUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

Collection

public Collection()

Method Detail

getUrl

@BeanProperty(value="url")
public String getUrl()

An IRI [RFC3987] referencing a JSON document containing the full listing of objects in the collection.

Returns:

The url

setUrl

@BeanProperty(value="url")
public void setUrl(String url)

An IRI [RFC3987] referencing a JSON document containing the full listing of objects in the collection.

Parameters:

url - The url

withUrl

public Collection withUrl(String url)

getTotalItems

@BeanProperty(value="totalItems")
public Long getTotalItems()

Non-negative integer specifying the total number of activities within the stream. The Stream serialization MAY contain a count property.

Returns:

The totalItems

setTotalItems

@BeanProperty(value="totalItems")
public void setTotalItems(Long totalItems)

Non-negative integer specifying the total number of activities within the stream. The Stream serialization MAY contain a count property.

Parameters:

totalItems - The totalItems

withTotalItems

public Collection withTotalItems(Long totalItems)

getItems

@BeanProperty(value="items")
public List<Item> getItems()

An array containing a listing of Objects of any object type. If used in combination with the url property, the items array can be used to provide a subset of the objects that may be found in the resource identified by the url. (Required)

Returns:

The items

setItems

@BeanProperty(value="items")
public void setItems(List<Item> items)

An array containing a listing of Objects of any object type. If used in combination with the url property, the items array can be used to provide a subset of the objects that may be found in the resource identified by the url. (Required)

Parameters:

items - The items

withItems

public Collection withItems(List<Item> items)

getLinks

@BeanProperty(value="links")
public List<Object> getLinks()

Links between an this object and other resources as defined in Web Linking

Returns:

The links

setLinks

@BeanProperty(value="links")
public void setLinks(List<Object> links)

Links between an this object and other resources as defined in Web Linking

Parameters:

links - The links

withLinks

public Collection withLinks(List<Object> links)

toString

public String toString()

Overrides:

toString in class Object

getAdditionalProperties

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

setAdditionalProperty

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

withAdditionalProperty

public Collection withAdditionalProperty(String name,
                                         Object value)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object