org.ogema.patternaccess.AdministrationPatternAccess Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of internal-api Show documentation

Internal API of the OGEMA 2.0 reference implementation by Fraunhofer Society.

The newest version!

/**
 * Copyright 2011-2018 Fraunhofer-Gesellschaft zur Förderung der angewandten Wissenschaften e.V.
 *
 * 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 org.ogema.patternaccess;

import java.util.List;

import org.ogema.core.administration.RegisteredPatternListener;
import org.ogema.core.resourcemanager.pattern.PatternListener;
import org.ogema.core.resourcemanager.pattern.ResourcePattern;
import org.ogema.core.resourcemanager.pattern.ResourcePatternAccess;

/**
 * Provides additional methods related to the pattern access, which are only 
 * accessible via the AdministrationManager, instead of the {@link ResourcePatternAccess}
 */
public interface AdministrationPatternAccess extends ResourcePatternAccess {
	
	/**
	 * Get the pattern listeners registered by this application. 
	 * @return
	 */
	List getRegisteredPatternListeners();
	
	/**
	 * Get the RegisteredPatternListener object belonging to a listener, which
	 * contains additional information about incomplete matches.

	 * Note that the listener must have been registered for a pattern demand prior to
	 * calling this 
	 * (see {@link ResourcePatternAccess#addPatternDemand(Class, PatternListener, org.ogema.core.resourcemanager.AccessPriority)},
	 * and related methods), otherwise null is returned.
	 * 
	 * @param listener
	 * @param pattern
	 * 		FIXME can the type be derived from the listener? 
	 * @return
	 * 		The pattern info object, or null if the listener registration has not been found.
	 */
	> RegisteredPatternListener getListenerInformation(PatternListener
 listener, Class pattern);
	
	void close();
	
}