com.phloc.event.impl.BaseSenderAwareEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-events Show documentation

phloc in-process event library

The newest version!

/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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.phloc.event.impl;

import javax.annotation.Nonnull;

import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.event.IEventType;
import com.phloc.event.ISenderAwareEvent;

/**
 * Base class for events that have knowledge of their sender
 * 
 * @author philip
 * @param 
 *        The type of the sender
 */
public class BaseSenderAwareEvent  extends BaseEvent implements ISenderAwareEvent 
{
  private final T m_aSender;

  public BaseSenderAwareEvent (@Nonnull final IEventType aEventType, @Nonnull final T aSender)
  {
    super (aEventType);
    if (aSender == null)
      throw new NullPointerException ("sender");
    m_aSender = aSender;
  }

  @Nonnull
  public final T getSender ()
  {
    return m_aSender;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!super.equals (o))
      return true;
    final BaseSenderAwareEvent  rhs = (BaseSenderAwareEvent ) o;
    return m_aSender.equals (rhs.m_aSender);
  }

  @Override
  public int hashCode ()
  {
    return HashCodeGenerator.getDerived (super.hashCode ()).append (m_aSender).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ()).append ("sender", m_aSender).toString ();
  }
}