org.springframework.yarn.am.grid.support

Class AbstractProjectedGrid

java.lang.Object

org.springframework.yarn.am.grid.support.AbstractProjectedGrid

All Implemented Interfaces:

ProjectedGrid

Direct Known Subclasses:

DefaultProjectedGrid

public abstract class AbstractProjectedGrid
extends java.lang.Object
implements ProjectedGrid

Simple ProjectedGrid base implementation.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
AbstractProjectedGrid(Grid grid) Instantiates a new abstract projected 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.
protected void	notifyGridProjectionAdded(GridProjection projection) Notifies registered ProjectedGridListeners that a GridProjection has been added to a ProjectedGrid.
protected void	notifyGridProjectionRemoved(GridProjection projection) Notifies registered ProjectedGridListeners that a GridProjection has been removed from a ProjectedGrid.
protected void	notifyMemberAdded(GridProjection projection, GridMember member) Notifies registered ContainerGridGroupsListeners that a ContainerNode has been added to a ContainerGroup.
protected void	notifyMemberRemoved(GridProjection projection, GridMember member) Notifies registered ContainerGridGroupsListeners that a ContainerNode has been removed from a ContainerGroup.
boolean	removeProjection(GridProjection projection) Removes a grid projection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProjectedGrid

public AbstractProjectedGrid(Grid grid)

Instantiates a new abstract projected grid.

Parameters:

grid - the grid

Method Detail

addProjection

public boolean addProjection(GridProjection projection)

Description copied from interface: ProjectedGrid

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.

Specified by:

addProjection in interface ProjectedGrid

Parameters:

projection - the grid projection

Returns:

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

removeProjection

public boolean removeProjection(GridProjection projection)

Description copied from interface: ProjectedGrid

Removes a grid projection.

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

Specified by:

removeProjection in interface ProjectedGrid

Parameters:

projection - the grid projection

Returns:

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

getProjections

public java.util.Collection<GridProjection> getProjections()

Description copied from interface: ProjectedGrid

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

Specified by:

getProjections in interface ProjectedGrid

Returns:

the collection of grid projections

addProjectedGridListener

public void addProjectedGridListener(ProjectedGridListener listener)

Description copied from interface: ProjectedGrid

Adds a listener to be notified of projected grid events.

Specified by:

addProjectedGridListener in interface ProjectedGrid

Parameters:

listener - the projected grid listener

notifyGridProjectionAdded

protected void notifyGridProjectionAdded(GridProjection projection)

Notifies registered ProjectedGridListeners that a GridProjection has been added to a ProjectedGrid.

Parameters:

projection - the grid projection

notifyGridProjectionRemoved

protected void notifyGridProjectionRemoved(GridProjection projection)

Notifies registered ProjectedGridListeners that a GridProjection has been removed from a ProjectedGrid.

Parameters:

projection - the grid projection

notifyMemberAdded

protected void notifyMemberAdded(GridProjection projection,
                     GridMember member)

Notifies registered ContainerGridGroupsListeners that a ContainerNode has been added to a ContainerGroup.

Parameters:

projection - the grid projection

member - the grid member

notifyMemberRemoved

protected void notifyMemberRemoved(GridProjection projection,
                       GridMember member)

Notifies registered ContainerGridGroupsListeners that a ContainerNode has been removed from a ContainerGroup.

Parameters:

projection - the group

member - the node