| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.factory;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">/**</a> |
| <span class="sourceLineNo">023</span><a id="line.23"> * Factory is an interface for object factories. Object factories</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * can be registered with the Factory Service to support customized</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * functionality during instantiation of specific classes that</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * the service itself cannot provide. Examples include</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * instantiation of XML parsers and secure sockets requiring</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * provider specific initializations before instantiation.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> *</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a></a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * @version $Id$</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> */</a> |
| <span class="sourceLineNo">034</span><a id="line.34">public interface Factory<T></a> |
| <span class="sourceLineNo">035</span><a id="line.35">{</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> /**</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * Initializes the factory. This method is called by</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * the Factory Service before the factory is used.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> *</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * @param className the name of the production class</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * @throws FactoryException if initialization fails.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> */</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> void init(String className) throws FactoryException;</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45"> /**</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * Gets an instance of a class.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @return the instance.</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> T getInstance() throws FactoryException;</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> /**</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * Gets an instance of a class using a specified class loader.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> *</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * <p>Class loaders are supported only if the isLoaderSupported</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * method returns true. Otherwise the loader parameter is ignored.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> *</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @param loader the class loader.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @return the instance.</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> */</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> T getInstance(ClassLoader loader) throws FactoryException;</a> |
| <span class="sourceLineNo">064</span><a id="line.64"></a> |
| <span class="sourceLineNo">065</span><a id="line.65"> /**</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * Gets an instance of a named class.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * Parameters for its constructor are given as an array of objects,</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * primitive types must be wrapped with a corresponding class.</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> *</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @param params an array containing the parameters of the constructor.</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @param signature an array containing the signature of the constructor.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @return the instance.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> T getInstance(Object[] params, String[] signature)</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> throws FactoryException;</a> |
| <span class="sourceLineNo">077</span><a id="line.77"></a> |
| <span class="sourceLineNo">078</span><a id="line.78"> /**</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * Gets an instance of a named class using a specified class loader.</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * Parameters for its constructor are given as an array of objects,</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * primitive types must be wrapped with a corresponding class.</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> *</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * <p>Class loaders are supported only if the isLoaderSupported</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * method returns true. Otherwise the loader parameter is ignored.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> *</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @param loader the class loader.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * @param params an array containing the parameters of the constructor.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @param signature an array containing the signature of the constructor.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @return the instance.</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> */</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> T getInstance(ClassLoader loader, Object[] params, String[] signature)</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> throws FactoryException;</a> |
| <span class="sourceLineNo">094</span><a id="line.94"></a> |
| <span class="sourceLineNo">095</span><a id="line.95"> /**</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * Tests if this object factory supports specified class loaders.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> *</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * @return true if class loaders are supported, false otherwise.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> */</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> boolean isLoaderSupported();</a> |
| <span class="sourceLineNo">101</span><a id="line.101">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
