| <!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"> * The Factory Service instantiates objects using either default</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * class loaders or a specified one. Whether specified class</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * loaders are supported for a class depends on implementation</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * and can be tested with the isLoaderSupported method.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a></a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a></a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * @version $Id$</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> */</a> |
| <span class="sourceLineNo">032</span><a id="line.32">public interface FactoryService</a> |
| <span class="sourceLineNo">033</span><a id="line.33">{</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> /**</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * The key under which this component is known by an avalon container.</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> */</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> String ROLE = FactoryService.class.getName();</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> /**</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * Gets an instance of a class.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @param <T> Type of the class</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @param clazz the name of the class.</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @return {@inheritDoc} the instance.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> */</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> <T> T getInstance(Class<T> clazz)</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> throws FactoryException;</a> |
| <span class="sourceLineNo">050</span><a id="line.50"></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> /**</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Gets an instance of a named class.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> *</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @param <T> Type of the class</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param className the name of the class.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @return {@inheritDoc} the instance.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> */</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> <T> T getInstance(String className)</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> throws FactoryException;</a> |
| <span class="sourceLineNo">061</span><a id="line.61"></a> |
| <span class="sourceLineNo">062</span><a id="line.62"> /**</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * Gets an instance of a named class using a specified class loader.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> *</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Class loaders are supported only if the isLoaderSupported</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * method returns true. Otherwise the loader parameter is ignored.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * </a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * @param <T> Type of the class</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @param className the name of the class.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @param loader the class loader.</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @return {@inheritDoc} the instance.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> */</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> <T> T getInstance(String className,</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> ClassLoader loader)</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.</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"> * @param <T> Type of the class</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * @param className the name of the class.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * @param params an array containing the parameters of the constructor.</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @param signature an array containing the signature of the constructor.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * @return {@inheritDoc} the instance.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> */</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> <T> T getInstance(String className,</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> Object[] params,</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> 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"> * Gets an instance of a named class using a specified class loader.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * Parameters for its constructor are given as an array of objects,</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * primitive types must be wrapped with a corresponding class.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> *</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * Class loaders are supported only if the isLoaderSupported</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * method returns true. Otherwise the loader parameter is ignored.</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> *</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * @param <T> Type of the class</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * @param className the name of the class.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * @param loader the class loader.</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * @param params an array containing the parameters of the constructor.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * @param signature an array containing the signature of the constructor.</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @return {@inheritDoc} the instance.</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * @throws FactoryException if instantiation fails.</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> */</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> <T> T getInstance(String className,</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> ClassLoader loader,</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> Object[] params,</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> String[] signature)</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> throws FactoryException;</a> |
| <span class="sourceLineNo">116</span><a id="line.116"></a> |
| <span class="sourceLineNo">117</span><a id="line.117"> /**</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * Tests if specified class loaders are supported for a named class.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> *</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @param className the name of the class.</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * @return true if class loaders are supported, false otherwise.</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @throws FactoryException if test fails.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> */</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> boolean isLoaderSupported(String className)</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> throws FactoryException;</a> |
| <span class="sourceLineNo">126</span><a id="line.126"></a> |
| <span class="sourceLineNo">127</span><a id="line.127"> /**</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * Gets the signature classes for parameters of a method of a class.</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> *</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @param clazz the class.</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @param params an array containing the parameters of the method.</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * @param signature an array containing the signature of the method.</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * </a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * @return {@inheritDoc} an array of signature classes. Note that in some cases</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * objects in the parameter array can be switched to the context</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * of a different class loader</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * </a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @throws ClassNotFoundException if any of the classes is not found.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> */</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> Class<?>[] getSignature(Class<?> clazz,</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> Object params[],</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> String signature[])</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> throws ClassNotFoundException;</a> |
| <span class="sourceLineNo">144</span><a id="line.144">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
