Package jetbrains.buildServer.web.impl

Class PagePlaceImpl

java.lang.Object

jetbrains.buildServer.web.impl.PagePlaceImpl

All Implemented Interfaces:

PagePlace

public class PagePlaceImpl
extends Object
implements PagePlace

Author:

Pavel.Sher Date: 25.12.2007

Constructor Summary

Constructors

Constructor	Description
PagePlaceImpl(PlaceId placeId)

Method Summary

Modifier and Type	Method	Description
void	addExtension(PageExtension pageExtension)	Adds new extension to this place (to the tail of extensions)
void	addExtension(PageExtension pageExtension, int zeroBasedPosition)	Adds new extension to this place, to the specified position.
void	addExtension(PageExtension pageExtension, PositionConstraint positionConstraint)	Adds new extension with position preference.
List<PageExtension>	getAvailableExtensions(javax.servlet.http.HttpServletRequest request)	Returns list of page extensions registered for this place and available for the specified request
PlaceId	getId()	Unique identifier of this page place
List<PageExtension>	getRegisteredExtensions()	Returns all registered extensions
boolean	removeExtension(PageExtension pageExtension)	Removes extension from this place
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PagePlaceImpl

public PagePlaceImpl(@NotNull
                     PlaceId placeId)

Method Detail

getId

@NotNull
public PlaceId getId()

Description copied from interface: PagePlace

Unique identifier of this page place

Specified by:

getId in interface PagePlace

Returns:

page place identifier

addExtension

public void addExtension(@NotNull
                         PageExtension pageExtension)

Description copied from interface: PagePlace

Adds new extension to this place (to the tail of extensions)

Specified by:

addExtension in interface PagePlace

Parameters:

pageExtension - page extension

addExtension

public void addExtension(@NotNull
                         PageExtension pageExtension,
                         int zeroBasedPosition)

Description copied from interface: PagePlace

Adds new extension to this place, to the specified position. Explicit position should be >= 0, negative value means position undefined. Extensions will be ordered to match requested position as much as possible.

Specified by:

addExtension in interface PagePlace

Parameters:

pageExtension - page extension

zeroBasedPosition - position for the extension, starting with 0; negative value means first available position

addExtension

public void addExtension(@NotNull
                         PageExtension pageExtension,
                         @Nullable
                         PositionConstraint positionConstraint)

Description copied from interface: PagePlace

Adds new extension with position preference. By default extension position is based on the extensions registration order, but with help of constraints it is possible to explicitly place extension in relation to other extensions.

Specified by:

addExtension in interface PagePlace

Parameters:

pageExtension - page extension

positionConstraint - constraint which can be used to position extension near other extensions

removeExtension

public boolean removeExtension(@NotNull
                               PageExtension pageExtension)

Description copied from interface: PagePlace

Removes extension from this place

Specified by:

removeExtension in interface PagePlace

Parameters:

pageExtension - extension to remove

Returns:

true if extension was removed

getAvailableExtensions

@NotNull
public List<PageExtension> getAvailableExtensions(@NotNull
                                                  javax.servlet.http.HttpServletRequest request)

Description copied from interface: PagePlace

Returns list of page extensions registered for this place and available for the specified request

Specified by:

getAvailableExtensions in interface PagePlace

Parameters:

request - HTTP request

Returns:

list of page extensions

getRegisteredExtensions

@NotNull
public List<PageExtension> getRegisteredExtensions()

Description copied from interface: PagePlace

Returns all registered extensions

Specified by:

getRegisteredExtensions in interface PagePlace

Returns:

all registered extensions

toString

public String toString()

Overrides:

toString in class Object