org.springframework.yarn.am.grid

Interface ProjectedGrid

All Known Implementing Classes:

AbstractProjectedGrid, DefaultProjectedGrid

public interface ProjectedGrid

ProjectedGrid

Author:

Janne Valkealahti

See Also:

Grid

Method Summary

Methods

Modifier and Type	Method and Description
void	addProjectedGridListener(ProjectedGridListener listener) Adds a listener to be notified of projected grid events.
boolean	addProjection(GridProjection projection) Adds a new grid projection.
java.util.Collection<GridProjection>	getProjections() Gets a collection of grid projections or empty collection of there are no projections defined.
boolean	removeProjection(GridProjection projection) Removes a grid projection.

Method Detail

addProjection

boolean addProjection(GridProjection projection)

Adds a new grid projection.

If a projected grid refuses to add a particular grid projection for any reason other than that it already contains the grid projection, it must throw an exception (rather than returning false). This preserves the invariant that a projected grid always contains the specified grid projection after this call returns.

Parameters:

projection - the grid projection

Returns:

true if this projected grid changed as a result of the call

removeProjection

boolean removeProjection(GridProjection projection)

Removes a grid projection.

Removes a single instance of the specified grid projection from this projected grid, if it is present.

Parameters:

projection - the grid projection

Returns:

true if a grid projection was removed as a result of this call

getProjections

java.util.Collection<GridProjection> getProjections()

Gets a collection of grid projections or empty collection of there are no projections defined.

Returns:

the collection of grid projections

addProjectedGridListener

void addProjectedGridListener(ProjectedGridListener listener)

Adds a listener to be notified of projected grid events.

Parameters:

listener - the projected grid listener