org.productivity.java.habitat4j.common.interfaces
Interface ReloadEventHandlerIF

All Known Implementing Classes:

SampleReloadEventHandler

public interface ReloadEventHandlerIF

Interface used to implement the preReload, postReload, and onReloadFailure event methods. In a class that implements this interface: If preReload(..) returns true, the reload will continue. If false, the reload will be interrupted and old properties will remain available to the application. If postReload(..) returns true, the reload will continue. If false, the reload will be interrupted and old properties will remain available to the application. onReloadFailure can be used to take action upon a failure.

## LICENSE INFORMATION ##

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Version:

$Id: ReloadEventHandlerIF.html,v 1.2 2008/11/24 15:15:20 cvs Exp $

Author:

Justin Yunke <habitat4j@productivity.org>

Method Summary

void	onReloadFailure(PropertyList oldPropertyList, PropertyListHandlerException exception)
boolean	postReload(PropertyList oldPropertyList, PropertyList newPropertyList)
boolean	preReload(PropertyList oldPropertyList)

Method Detail

preReload

boolean preReload(PropertyList oldPropertyList)

Parameters:

oldPropertyList - - the PropertyList instance available prior to the reload

Returns:

Returns "true" if the reload process should continue, else "false"

postReload

boolean postReload(PropertyList oldPropertyList,
                   PropertyList newPropertyList)

Parameters:

oldPropertyList - - the PropertyList instance available prior to the reload

newPropertyList - - the PropertyList instance available after reload

Returns:

Returns "true" if the reload process should continue, else "false"

onReloadFailure

void onReloadFailure(PropertyList oldPropertyList,
                     PropertyListHandlerException exception)

Parameters:

oldPropertyList - - the PropertyList instance available prior to the reload

exception - - the PropertyListHandlerException instance that will be thrown by Habitat4J