All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jboss.arquillian.spi.Context Maven / Gradle / Ivy

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2009, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.jboss.arquillian.spi;

import org.jboss.arquillian.spi.event.Event;
import org.jboss.arquillian.spi.event.suite.EventHandler;


/**
 * The arquillian test lifecycle context.  
 *
 * @author Aslak Knutsen
 * @version $Revision: $
 */
public interface Context 
{
   /**
    * Fire a new {@link Event}.
    * 
    * @param event The {@link Event} instance to fire
    */
   void  fire(Event event); 
   
   /**
    * Register a {@link EventHandler} for a specific {@link Event}.
    * 
    * @param 
    * @param eventType The Type of {@link Event} to listen to
    * @param handler The receiver of the {@link Event}
    */
    void register(Class eventType, EventHandler handler);

   /**
    * Get the defined {@link ServiceLoader}
    * 
    * @return A instance of {@link ServiceLoader}
    * @see #get(Class)
    */
   ServiceLoader getServiceLoader();
   
   /**
    * Get this contexts parent context.
    * 
    * @return The parent context if any, null if this is the top context.
    */
   Context getParentContext();

   /**
    * Add a instance of B to the context.
    * 
    * @param 
    * @param type The Type of the instance to add
    * @param instance The instance to add
    */
    void add(Class type, B instance);
   
   /**
    * Get a instance of B from the context.
    * 
    * @param 
    * @param type Type to lookup
    * @return A instance of B or null if not found
    */
    B get(Class type);
}