user/src/com/google/gwt/event/logical/shared/ValueChangeEvent.java

/*
 * Copyright 2008 Google 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.google.gwt.event.logical.shared;

import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HandlerManager;

/**
 * Represents a value change event.
 * 
 * @param <I> the value about to be changed
 */
public class ValueChangeEvent<I> extends GwtEvent<ValueChangeHandler<I>> {

  /**
   * Handler type.
   */
  private static Type<ValueChangeHandler<?>> TYPE;

  /**
   * Fires a value change event on all registered handlers in the handler
   * manager.If no such handlers exist, this method will do nothing.
   * 
   * @param <I> the old value type
   * @param source the source of the handlers
   * @param value the value
   */
  public static <I> void fire(HasValueChangeHandlers<I> source, I value) {
    if (TYPE != null) {
      HandlerManager handlers = source.getHandlers();
      if (handlers != null && handlers.isEventHandled(TYPE)) {
        ValueChangeEvent<I> event = new ValueChangeEvent<I>(value);
        handlers.fireEvent(event);
      }
    }
  }

  /**
   * Fires value change event if the old value is not equal to the new value.
   * Use this call rather than making the decision to short circuit yourself for
   * safe handling of null.
   * 
   * @param <I> the old value type
   * @param <S> The event source
   * @param source the source of the handlers
   * @param oldValue the oldValue, may be null
   * @param newValue the newValue, may be null
   */
  public static <I> void fireIfNotEqual(HasValueChangeHandlers<I> source,
      I oldValue, I newValue) {
    if (shouldFire(source, oldValue, newValue)) {
      ValueChangeEvent<I> event = new ValueChangeEvent<I>(newValue);
      source.getHandlers().fireEvent(event);
    }
  }

  /**
   * Gets the type associated with this event.
   * 
   * @return returns the handler type
   */
  public static Type<ValueChangeHandler<?>> getType() {
    if (TYPE == null) {
      TYPE = new Type<ValueChangeHandler<?>>();
    }
    return TYPE;
  }

  /**
   * Convenience method to allow subtypes to know when they should fire a value
   * change event in a null-safe manner.
   * 
   * @param <I> value type
   * @param source the source
   * @param oldValue the old value
   * @param newValue the new value
   * @return whether the event should be fired
   */
  protected static <I> boolean shouldFire(HasValueChangeHandlers<I> source,
      I oldValue, I newValue) {
    return TYPE != null && source.getHandlers() != null && oldValue != newValue
        && (oldValue == null || !oldValue.equals(newValue));
  }

  private final I value;

  /**
   * Creates a value change event.
   * 
   * @param value the value
   */
  protected ValueChangeEvent(I value) {
    this.value = value;
  }

  // The instance knows its BeforeSelectionHandler is of type I, but the TYPE
  // field itself does not, so we have to do an unsafe cast here.
  @SuppressWarnings("unchecked")
  @Override
  public Type<ValueChangeHandler<I>> getAssociatedType() {
    return (Type) TYPE;
  }

  /**
   * Gets the value.
   * 
   * @return the value
   */
  public I getValue() {
    return value;
  }

  @Override
  protected void dispatch(ValueChangeHandler<I> handler) {
    handler.onValueChange(this);
  }
}