blob: 8b71e48869d70f9691ad7c57bd2ad4176ceaa20b [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.log4j.config;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import java.beans.PropertyDescriptor;<a name="line.19"></a>
<FONT color="green">020</FONT> import java.util.Properties;<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> /**<a name="line.22"></a>
<FONT color="green">023</FONT> *<a name="line.23"></a>
<FONT color="green">024</FONT> * @since 1.1<a name="line.24"></a>
<FONT color="green">025</FONT> */<a name="line.25"></a>
<FONT color="green">026</FONT> public class PropertySetter {<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * Create a new PropertySetter for the specified Object. This is done<a name="line.29"></a>
<FONT color="green">030</FONT> * in preparation for invoking {@link #setProperty} one or more times.<a name="line.30"></a>
<FONT color="green">031</FONT> *<a name="line.31"></a>
<FONT color="green">032</FONT> * @param obj the object for which to set properties<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public PropertySetter(final Object obj) {<a name="line.34"></a>
<FONT color="green">035</FONT> }<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /**<a name="line.38"></a>
<FONT color="green">039</FONT> * Set the properties for the object that match the &lt;code&gt;prefix&lt;/code&gt; passed as parameter.<a name="line.39"></a>
<FONT color="green">040</FONT> *<a name="line.40"></a>
<FONT color="green">041</FONT> * @param properties The properties<a name="line.41"></a>
<FONT color="green">042</FONT> * @param prefix The prefix<a name="line.42"></a>
<FONT color="green">043</FONT> */<a name="line.43"></a>
<FONT color="green">044</FONT> public void setProperties(final Properties properties, final String prefix) {<a name="line.44"></a>
<FONT color="green">045</FONT> }<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * Set a property on this PropertySetter's Object. If successful, this<a name="line.48"></a>
<FONT color="green">049</FONT> * method will invoke a setter method on the underlying Object. The<a name="line.49"></a>
<FONT color="green">050</FONT> * setter is the one for the specified property name and the value is<a name="line.50"></a>
<FONT color="green">051</FONT> * determined partly from the setter argument type and partly from the<a name="line.51"></a>
<FONT color="green">052</FONT> * value specified in the call to this method.<a name="line.52"></a>
<FONT color="green">053</FONT> *<a name="line.53"></a>
<FONT color="green">054</FONT> * &lt;p&gt;If the setter expects a String no conversion is necessary.<a name="line.54"></a>
<FONT color="green">055</FONT> * If it expects an int, then an attempt is made to convert 'value'<a name="line.55"></a>
<FONT color="green">056</FONT> * to an int using new Integer(value). If the setter expects a boolean,<a name="line.56"></a>
<FONT color="green">057</FONT> * the conversion is by new Boolean(value).<a name="line.57"></a>
<FONT color="green">058</FONT> *<a name="line.58"></a>
<FONT color="green">059</FONT> * @param name name of the property<a name="line.59"></a>
<FONT color="green">060</FONT> * @param value String value of the property<a name="line.60"></a>
<FONT color="green">061</FONT> */<a name="line.61"></a>
<FONT color="green">062</FONT> public void setProperty(final String name, final String value) {<a name="line.62"></a>
<FONT color="green">063</FONT> }<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /**<a name="line.65"></a>
<FONT color="green">066</FONT> * Set the named property given a {@link PropertyDescriptor}.<a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> * @param prop A PropertyDescriptor describing the characteristics of the property to set.<a name="line.68"></a>
<FONT color="green">069</FONT> * @param name The named of the property to set.<a name="line.69"></a>
<FONT color="green">070</FONT> * @param value The value of the property.<a name="line.70"></a>
<FONT color="green">071</FONT> * @throws PropertySetterException (Never actually throws this exception. Kept for historical purposes.)<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> public void setProperty(final PropertyDescriptor prop, final String name, final String value)<a name="line.73"></a>
<FONT color="green">074</FONT> throws PropertySetterException {<a name="line.74"></a>
<FONT color="green">075</FONT> }<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Set the properties of an object passed as a parameter in one<a name="line.78"></a>
<FONT color="green">079</FONT> * go. The &lt;code&gt;properties&lt;/code&gt; are parsed relative to a<a name="line.79"></a>
<FONT color="green">080</FONT> * &lt;code&gt;prefix&lt;/code&gt;.<a name="line.80"></a>
<FONT color="green">081</FONT> *<a name="line.81"></a>
<FONT color="green">082</FONT> * @param obj The object to configure.<a name="line.82"></a>
<FONT color="green">083</FONT> * @param properties A java.util.Properties containing keys and values.<a name="line.83"></a>
<FONT color="green">084</FONT> * @param prefix Only keys having the specified prefix will be set.<a name="line.84"></a>
<FONT color="green">085</FONT> */<a name="line.85"></a>
<FONT color="green">086</FONT> public static void setProperties(final Object obj, final Properties properties, final String prefix) {<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
</PRE>
</BODY>
</HTML>