blob: 229cd7bdb3733c51a0b1c7c9751b55bde98bf3a4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Favourite xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/apache/log4j/chainsaw/favourites/Favourite.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong>package</strong> org.apache.log4j.chainsaw.favourites;
<a name="2" href="#2">2</a>
<a name="3" href="#3">3</a> <em>/**<em>*</em></em>
<a name="4" href="#4">4</a> <em> * A Fauvourite is just a named container of on object that can be used</em>
<a name="5" href="#5">5</a> <em> * as a basis (prototype) for the creation of exact copies.</em>
<a name="6" href="#6">6</a> <em> * </em>
<a name="7" href="#7">7</a> <em> * Clients should use the FavouritesRegistry to create instances of this class</em>
<a name="8" href="#8">8</a> <em> * so that explicit checks can be performed about the suitability of the</em>
<a name="9" href="#9">9</a> <em> * prototype.</em>
<a name="10" href="#10">10</a> <em> * </em>
<a name="11" href="#11">11</a> <em> * @author Paul Smith &lt;psmith@apache.org></em>
<a name="12" href="#12">12</a> <em> *</em>
<a name="13" href="#13">13</a> <em> */</em>
<a name="14" href="#14">14</a> <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../../org/apache/log4j/chainsaw/favourites/Favourite.html">Favourite</a> {
<a name="15" href="#15">15</a>
<a name="16" href="#16">16</a> <strong>private</strong> String name;
<a name="17" href="#17">17</a> <strong>private</strong> Object prototype;
<a name="18" href="#18">18</a>
<a name="19" href="#19">19</a> <em>/**<em>*</em></em>
<a name="20" href="#20">20</a> <em> * @param name</em>
<a name="21" href="#21">21</a> <em> * @param object</em>
<a name="22" href="#22">22</a> <em> */</em>
<a name="23" href="#23">23</a> <a href="../../../../../org/apache/log4j/chainsaw/favourites/Favourite.html">Favourite</a>(String name, Object prtotype) {
<a name="24" href="#24">24</a> <strong>this</strong>.name = name;
<a name="25" href="#25">25</a> <strong>this</strong>.prototype = prtotype;
<a name="26" href="#26">26</a> }
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em>/**<em>*</em></em>
<a name="30" href="#30">30</a> <em> * @return Returns the name.</em>
<a name="31" href="#31">31</a> <em> */</em>
<a name="32" href="#32">32</a> <strong>public</strong> <strong>final</strong> String getName() {
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <strong>return</strong> name;
<a name="35" href="#35">35</a> }
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <em>/**<em>*</em></em>
<a name="38" href="#38">38</a> <em> * Returns the object that would be used as a basis to create new</em>
<a name="39" href="#39">39</a> <em> * instances of that same object.</em>
<a name="40" href="#40">40</a> <em> * @return Returns the prototype.</em>
<a name="41" href="#41">41</a> <em> */</em>
<a name="42" href="#42">42</a> <strong>public</strong> <strong>final</strong> Object getPrototype() {
<a name="43" href="#43">43</a> <strong>return</strong> prototype;
<a name="44" href="#44">44</a> }
<a name="45" href="#45">45</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>