src/org/mxchange/jcore/model/BaseModel.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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 package org.mxchange.jcore.model;
  18
  19 import java.text.MessageFormat;
  20 import javax.swing.event.EventListenerList;
  21 import javax.swing.event.ListDataListener;
  22 import javax.swing.event.TableModelListener;
  23 import org.mxchange.jcore.BaseFrameworkSystem;
  24
  25 /**
  26  *
  27  * @author Roland Haeder
  28  */
  29 public class BaseModel extends BaseFrameworkSystem {
  30
  31         /**
  32          * List of event listeners
  33          */
  34         private final EventListenerList eventListenerList;
  35
  36         /**
  37          * Protected constructor
  38          */
  39         protected BaseModel () {
  40                 // Trace message
  41                 this.getLogger().trace("CALLED!"); //NOI18N
  42
  43                 // Init listener list
  44                 this.eventListenerList = new EventListenerList();
  45         }
  46
  47         /**
  48          * Adds a lister of this type to the list
  49          *
  50          * @param listener Listener instance
  51          */
  52         public void addListDataListener (final ListDataListener listener) {
  53                 // Trace message
  54                 this.getLogger().trace("listener=" + listener + " - CALLED!"); //NOI18N
  55
  56                 // Listener must not be null
  57                 if (listener == null) {
  58                         // Abort here
  59                         throw new NullPointerException("listener is null");
  60                 }
  61
  62                 // Debug message
  63                 this.getLogger().debug(MessageFormat.format("Adding listener {0} ...", listener.getClass()));
  64
  65                 // Remove listener
  66                 this.eventListenerList.add(ListDataListener.class, listener);
  67
  68                 // Trace message
  69                 this.getLogger().trace("EXIT!"); //NOI18N
  70         }
  71
  72         /**
  73          * Adds a TableModel listener instance to the event list.
  74          *
  75          * @param listener Lister instance
  76          */
  77         public void addTableModelListener (final TableModelListener listener) {
  78                 // Trace message
  79                 this.getLogger().trace("listener=" + listener + " - CALLED!"); //NOI18N
  80
  81                 // Listener must not be null
  82                 if (listener == null) {
  83                         // Abort here
  84                         throw new NullPointerException("listener is null");
  85                 }
  86
  87                 // Debug message
  88                 this.getLogger().debug(MessageFormat.format("Adding listener {0} ...", listener.getClass()));
  89
  90                 // Add listener
  91                 this.eventListenerList.add(TableModelListener.class, listener);
  92
  93                 // Trace message
  94                 this.getLogger().trace("EXIT!"); //NOI18N
  95         }
  96
  97         /**
  98          * Removes given listener
  99          *
 100          * @param listener Listener instance
 101          */
 102         public void removeListDataListener (final ListDataListener listener) {
 103                 // Trace message
 104                 this.getLogger().trace("listener=" + listener + " - CALLED!"); //NOI18N
 105
 106                 // Listener must not be null
 107                 if (listener == null) {
 108                         // Abort here
 109                         throw new NullPointerException("listener is null");
 110                 }
 111
 112                 // Debug message
 113                 this.getLogger().debug(MessageFormat.format("Removing listener {0} ...", listener.getClass()));
 114
 115                 // Remove listener
 116                 this.eventListenerList.remove(ListDataListener.class, listener);
 117
 118                 // Trace message
 119                 this.getLogger().trace("EXIT!"); //NOI18N
 120         }
 121
 122         /**
 123          * Removes a TableModel listener instance from the event list.
 124          *
 125          * @param listener Listener instance
 126          */
 127         public void removeTableModelListener (final TableModelListener listener) {
 128                 // Trace message
 129                 this.getLogger().trace("listener=" + listener + " - CALLED!"); //NOI18N
 130
 131                 // Listener must not be null
 132                 if (listener == null) {
 133                         // Abort here
 134                         throw new NullPointerException("listener is null");
 135                 }
 136
 137                 // Debug message
 138                 this.getLogger().debug(MessageFormat.format("Removing listener {0} ...", listener.getClass()));
 139
 140                 // Remove listener
 141                 this.eventListenerList.remove(TableModelListener.class, listener);
 142
 143                 // Trace message
 144                 this.getLogger().trace("EXIT!"); //NOI18N
 145         }
 146 }