/*******************************************************************************
*   Copyright 2014 Analog Devices, Inc.
*
*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at
*
*       http://www.apache.org/licenses/LICENSE-2.0
*
*   Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.
********************************************************************************/

package com.analog.lyric.dimple.events;

/**
 * A {@link DimpleEvent} handler that does nothing other than to consume the event,
 * preventing it from any processing by any upstream handler.
 * 
 * @since 0.06
 * @author Christopher Barber
 */
public enum DimpleEventBlocker implements IDimpleEventHandler<DimpleEvent>
{
	INSTANCE;
	
	/**
	 * {@inheritDoc}
	 * 
	 * Simply sets {@link DimpleEvent#consumed(boolean)} to true.
	 */
	@Override
	public void handleEvent(DimpleEvent event)
	{
		event.consumed(true);
	}

	@Override
	public final boolean isBlocker()
	{
		return true;
	}
}
