src/main/java/net/pterodactylus/sone/freenet/wot/event/IdentityEvent.java

   1 /*
   2  * Sone - IdentityEvent.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.freenet.wot.event;
  19
  20 import net.pterodactylus.sone.freenet.wot.Identity;
  21 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  22
  23 /**
  24  * Base class for {@link Identity} events.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public abstract class IdentityEvent {
  29
  30         /** The own identity this event relates to. */
  31         private final OwnIdentity ownIdentity;
  32
  33         /** The identity this event is about. */
  34         private final Identity identity;
  35
  36         /**
  37          * Creates a new identity-based event.
  38          *
  39          * @param ownIdentity
  40          *            The own identity that relates to the identity
  41          * @param identity
  42          *            The identity this event is about
  43          */
  44         protected IdentityEvent(OwnIdentity ownIdentity, Identity identity) {
  45                 this.ownIdentity = ownIdentity;
  46                 this.identity = identity;
  47         }
  48
  49         //
  50         // ACCESSORS
  51         //
  52
  53         /**
  54          * Returns the own identity this event relates to.
  55          *
  56          * @return The own identity this event relates to
  57          */
  58         public OwnIdentity ownIdentity() {
  59                 return ownIdentity;
  60         }
  61
  62         /**
  63          * Returns the identity this event is about.
  64          *
  65          * @return The identity this event is about
  66          */
  67         public Identity identity() {
  68                 return identity;
  69         }
  70
  71 }