Package org.apache.wicket.http2.markup.head

Class PushItem

java.lang.Object

org.apache.wicket.http2.markup.head.PushItem

All Implemented Interfaces:

Serializable

public class PushItem
extends Object
implements Serializable

The object to be pushed. See the urlFor methods of Component to know what can be used in addition to String.

Author:

Tobias Soloschenko

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PushItem()	Creates a push item
PushItem(Serializable object)	Creates a push item
PushItem(Serializable object, Map<String,PushItemHeaderValue> headers)	Creates a push item
PushItem(Serializable object, PageParameters pageParameters)	Creates a push item
PushItem(Serializable object, PageParameters pageParameters, Map<String,PushItemHeaderValue> headers)	Creates a push item

Method Summary

Modifier and Type	Method	Description
Map<String,PushItemHeaderValue>	getHeaders()	Gets the headers to be added to the push response
Object	getObject()	Gets the object which contains the push URL information
PageParameters	getPageParameters()	Gets the page parameters
String	getUrl()	Gets the URL composed within the push header item
PushItem	setHeaders(Map<String,PushItemHeaderValue> headers)	Sets the headers to be added to the push response
PushItem	setObject(Serializable object)	Sets the object which contains the push URL information
PushItem	setPageParameters(PageParameters pageParameters)	Sets the page parameters
PushItem	setUrl(String url)	Sets the URL composed within the push header item

Methods inherited from class java.lang.Object

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

Constructor Detail

PushItem

public PushItem(Serializable object,
                PageParameters pageParameters,
                Map<String,PushItemHeaderValue> headers)

Creates a push item

Parameters:

object - the object to extract the push URL information from

pageParameters - the page parameters

headers - the headers to be applied to the push

PushItem

public PushItem(Serializable object,
                Map<String,PushItemHeaderValue> headers)

Creates a push item

Parameters:

object - the object to extract the push URL information from

headers - the headers to be applied to the push

PushItem

public PushItem(Serializable object,
                PageParameters pageParameters)

Creates a push item

Parameters:

object - the object to extract the push URL information from

pageParameters - the page parameters

PushItem

public PushItem(Serializable object)

Creates a push item

Parameters:

object - the object to extract the push URL information from

PushItem

public PushItem()

Creates a push item

Method Detail

getObject

public Object getObject()

Gets the object which contains the push URL information

Returns:

the object to extract the push URL information from

setObject

public PushItem setObject(Serializable object)

Sets the object which contains the push URL information

Parameters:

object - the object to extract the push URL information from

Returns:

the push item

See Also:

(urlFor methods)

getPageParameters

public PageParameters getPageParameters()

Gets the page parameters

Returns:

the page parameters

setPageParameters

public PushItem setPageParameters(PageParameters pageParameters)

Sets the page parameters

Parameters:

pageParameters - the page parameters

Returns:

the push item

getUrl

public String getUrl()

Gets the URL composed within the push header item

Returns:

the URL to be pushed

See Also:

PushHeaderItem.push(List)

setUrl

public PushItem setUrl(String url)

Sets the URL composed within the push header item

Parameters:

url - the URL used to push the resource

Returns:

the push item

See Also:

PushHeaderItem.push(List)

getHeaders

public Map<String,PushItemHeaderValue> getHeaders()

Gets the headers to be added to the push response

Returns:

the headers to be added to the push response

setHeaders

public PushItem setHeaders(Map<String,PushItemHeaderValue> headers)

Sets the headers to be added to the push response

Parameters:

headers - the headers to be added to the push response

Returns:

the push item