jacoco/org.apache.fulcrum.factory/FactoryService.java.html - turbine-fulcrum-factory - Git at Google

 <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>FactoryService.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Fulcrum Factory</a> &gt; <a href="index.source.html" class="el_package">org.apache.fulcrum.factory</a> &gt; <span class="el_source">FactoryService.java</span></div><h1>FactoryService.java</h1><pre class="source lang-java linenums">package org.apache.fulcrum.factory;

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * &quot;License&quot;); 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
  * &quot;AS IS&quot; 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.
  */

 /**
  * The Factory Service instantiates objects using either default
  * class loaders or a specified one. Whether specified class
  * loaders are supported for a class depends on implementation
  * and can be tested with the isLoaderSupported method.
  *
  * @author &lt;a href=&quot;mailto:epugh@upstate.com&quot;&gt;Eric Pugh&lt;/a&gt;
  * @author &lt;a href=&quot;mailto:ilkka.priha@simsoft.fi&quot;&gt;Ilkka Priha&lt;/a&gt;
  * @version $Id$
  */
 public interface FactoryService
 {
     /**
      * The key under which this component is known by an avalon container.
      */
 <span class="nc" id="L37">    String ROLE = FactoryService.class.getName();</span>


 	/**
 	* Gets an instance of a class.
 	*
 	* @param &lt;T&gt; Type of the class
 	* @param clazz the name of the class.
 	* @return {@inheritDoc} the instance.
 	* @throws FactoryException if instantiation fails.
 	*/
    &lt;T&gt; T getInstance(Class&lt;T&gt; clazz)
 	   throws FactoryException;

     /**
      * Gets an instance of a named class.
      *
      * @param &lt;T&gt; Type of the class
      * @param className the name of the class.
      * @return {@inheritDoc} the instance.
      * @throws FactoryException if instantiation fails.
      */
     &lt;T&gt; T getInstance(String className)
         throws FactoryException;

     /**
      * Gets an instance of a named class using a specified class loader.
      *
      * Class loaders are supported only if the isLoaderSupported
      * method returns true. Otherwise the loader parameter is ignored.
      *
      * @param &lt;T&gt; Type of the class
      * @param className the name of the class.
      * @param loader the class loader.
      * @return {@inheritDoc} the instance.
      * @throws FactoryException if instantiation fails.
      */
     &lt;T&gt; T getInstance(String className,
                               ClassLoader loader)
         throws FactoryException;

     /**
      * Gets an instance of a named class.
      * Parameters for its constructor are given as an array of objects,
      * primitive types must be wrapped with a corresponding class.
      *
      * @param &lt;T&gt; Type of the class
      * @param className the name of the class.
      * @param params an array containing the parameters of the constructor.
      * @param signature an array containing the signature of the constructor.
      * @return {@inheritDoc} the instance.
      * @throws FactoryException if instantiation fails.
      */
     &lt;T&gt; T getInstance(String className,
                               Object[] params,
                               String[] signature)
         throws FactoryException;

     /**
      * Gets an instance of a named class using a specified class loader.
      * Parameters for its constructor are given as an array of objects,
      * primitive types must be wrapped with a corresponding class.
      *
      * Class loaders are supported only if the isLoaderSupported
      * method returns true. Otherwise the loader parameter is ignored.
      *
      * @param &lt;T&gt; Type of the class
      * @param className the name of the class.
      * @param loader the class loader.
      * @param params an array containing the parameters of the constructor.
      * @param signature an array containing the signature of the constructor.
      * @return {@inheritDoc} the instance.
      * @throws FactoryException if instantiation fails.
      */
     &lt;T&gt; T getInstance(String className,
                               ClassLoader loader,
                               Object[] params,
                               String[] signature)
         throws FactoryException;

     /**
      * Tests if specified class loaders are supported for a named class.
      *
      * @param className the name of the class.
      * @return true if class loaders are supported, false otherwise.
      * @throws FactoryException if test fails.
      */
     boolean isLoaderSupported(String className)
         throws FactoryException;

     /**
      * Gets the signature classes for parameters of a method of a class.
      *
      * @param clazz the class.
      * @param params an array containing the parameters of the method.
      * @param signature an array containing the signature of the method.
      *
      * @return {@inheritDoc} an array of signature classes. Note that in some cases
      * objects in the parameter array can be switched to the context
      * of a different class loader
      *
      * @throws ClassNotFoundException if any of the classes is not found.
      */
     Class&lt;?&gt;[] getSignature(Class&lt;?&gt; clazz,
             Object params[],
             String signature[])
             throws ClassNotFoundException;
 }
 </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.6.202009150832</span></div></body></html>
	<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>FactoryService.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Fulcrum Factory</a> > <a href="index.source.html" class="el_package">org.apache.fulcrum.factory</a> > <span class="el_source">FactoryService.java</span></div><h1>FactoryService.java</h1><pre class="source lang-java linenums">package org.apache.fulcrum.factory;

	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.
	*/

	/**
	* The Factory Service instantiates objects using either default
	* class loaders or a specified one. Whether specified class
	* loaders are supported for a class depends on implementation
	* and can be tested with the isLoaderSupported method.
	*
	* @author <a href="mailto:epugh@upstate.com">Eric Pugh</a>
	* @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
	* @version $Id$
	*/
	public interface FactoryService
	{
	/**
	* The key under which this component is known by an avalon container.
	*/
	<span class="nc" id="L37"> String ROLE = FactoryService.class.getName();</span>


	/**
	* Gets an instance of a class.
	*
	* @param <T> Type of the class
	* @param clazz the name of the class.
	* @return {@inheritDoc} the instance.
	* @throws FactoryException if instantiation fails.
	*/
	<T> T getInstance(Class<T> clazz)
	throws FactoryException;

	/**
	* Gets an instance of a named class.
	*
	* @param <T> Type of the class
	* @param className the name of the class.
	* @return {@inheritDoc} the instance.
	* @throws FactoryException if instantiation fails.
	*/
	<T> T getInstance(String className)
	throws FactoryException;

	/**
	* Gets an instance of a named class using a specified class loader.
	*
	* Class loaders are supported only if the isLoaderSupported
	* method returns true. Otherwise the loader parameter is ignored.
	*
	* @param <T> Type of the class
	* @param className the name of the class.
	* @param loader the class loader.
	* @return {@inheritDoc} the instance.
	* @throws FactoryException if instantiation fails.
	*/
	<T> T getInstance(String className,
	ClassLoader loader)
	throws FactoryException;

	/**
	* Gets an instance of a named class.
	* Parameters for its constructor are given as an array of objects,
	* primitive types must be wrapped with a corresponding class.
	*
	* @param <T> Type of the class
	* @param className the name of the class.
	* @param params an array containing the parameters of the constructor.
	* @param signature an array containing the signature of the constructor.
	* @return {@inheritDoc} the instance.
	* @throws FactoryException if instantiation fails.
	*/
	<T> T getInstance(String className,
	Object[] params,
	String[] signature)
	throws FactoryException;

	/**
	* Gets an instance of a named class using a specified class loader.
	* Parameters for its constructor are given as an array of objects,
	* primitive types must be wrapped with a corresponding class.
	*
	* Class loaders are supported only if the isLoaderSupported
	* method returns true. Otherwise the loader parameter is ignored.
	*
	* @param <T> Type of the class
	* @param className the name of the class.
	* @param loader the class loader.
	* @param params an array containing the parameters of the constructor.
	* @param signature an array containing the signature of the constructor.
	* @return {@inheritDoc} the instance.
	* @throws FactoryException if instantiation fails.
	*/
	<T> T getInstance(String className,
	ClassLoader loader,
	Object[] params,
	String[] signature)
	throws FactoryException;

	/**
	* Tests if specified class loaders are supported for a named class.
	*
	* @param className the name of the class.
	* @return true if class loaders are supported, false otherwise.
	* @throws FactoryException if test fails.
	*/
	boolean isLoaderSupported(String className)
	throws FactoryException;

	/**
	* Gets the signature classes for parameters of a method of a class.
	*
	* @param clazz the class.
	* @param params an array containing the parameters of the method.
	* @param signature an array containing the signature of the method.
	*
	* @return {@inheritDoc} an array of signature classes. Note that in some cases
	* objects in the parameter array can be switched to the context
	* of a different class loader
	*
	* @throws ClassNotFoundException if any of the classes is not found.
	*/
	Class<?>[] getSignature(Class<?> clazz,
	Object params[],
	String signature[])
	throws ClassNotFoundException;
	}
	</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.6.202009150832</span></div></body></html>