001/* 002 Licensed to the Apache Software Foundation (ASF) under one 003 or more contributor license agreements. See the NOTICE file 004 distributed with this work for additional information 005 regarding copyright ownership. The ASF licenses this file 006 to you under the Apache License, Version 2.0 (the 007 "License"); you may not use this file except in compliance 008 with the License. You may obtain a copy of the License at 009 010 http://www.apache.org/licenses/LICENSE-2.0 011 012 Unless required by applicable law or agreed to in writing, 013 software distributed under the License is distributed on an 014 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 KIND, either express or implied. See the License for the 016 specific language governing permissions and limitations 017 under the License. 018 */ 019package org.apache.wiki.api.events; 020 021import org.apache.wiki.api.core.Engine; 022import org.apache.wiki.api.engine.Initializable; 023import org.apache.wiki.event.WikiEventListener; 024 025import java.util.ArrayList; 026import java.util.List; 027import java.util.Properties; 028 029/** 030 * 031 * @param <T> the type of the events' source. 032 */ 033public interface CustomWikiEventListener< T > extends WikiEventListener, Initializable { 034 035 /** {@link WikiEventListener}s are stored on a {@code List< WeaKReference >} so we use this List to strong reference custom event listeners. */ 036 List< CustomWikiEventListener< ? > > LISTENERS = new ArrayList<>(); 037 038 /** 039 * Returns the object of the events' source. Typically, it will be obtained on the 040 * {@link Initializable#initialize(Engine, Properties)} method, and returned here. 041 * 042 * @return the object of the events' source. 043 */ 044 T client(); 045 046}