You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by bo...@apache.org on 2013/05/28 08:26:19 UTC

svn commit: r1486771 [4/6] - in /myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt: ./ images/ xref/ xref/org/apache/myfaces/tobago/ant/sniplet/ xref/org/apache/myfaces/tobago/apt/generate/ xref/org/apache/myfaces/tobago/apt/processor/

Added: myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt/xref/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html
URL: http://svn.apache.org/viewvc/myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt/xref/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html?rev=1486771&view=auto
==============================================================================
--- myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt/xref/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html (added)
+++ myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt/xref/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html Tue May 28 06:26:19 2013
@@ -0,0 +1,203 @@
+<!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="de_DE" lang="de_DE">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>ReferenceGenerator xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a name="3" href="#3">3</a>   <em class="jxr_comment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a name="4" href="#4">4</a>   <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a name="5" href="#5">5</a>   <em class="jxr_comment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a name="6" href="#6">6</a>   <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a name="7" href="#7">7</a>   <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License.  You may obtain a copy of the License at</em>
+<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
+<a name="10" href="#10">10</a>  <em class="jxr_comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
+<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a name="13" href="#13">13</a>  <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a name="14" href="#14">14</a>  <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a name="15" href="#15">15</a>  <em class="jxr_comment"> * KIND, either express or implied.  See the License for the</em>
+<a name="16" href="#16">16</a>  <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a name="17" href="#17">17</a>  <em class="jxr_comment"> * under the License.</em>
+<a name="18" href="#18">18</a>  <em class="jxr_comment"> */</em>
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong class="jxr_keyword">package</strong> org.apache.myfaces.tobago.apt.processor;
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.io.IOUtils;
+<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.ClassUtils;
+<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
+<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.myfaces.tobago.apt.annotation.BodyContent;
+<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.apache.myfaces.tobago.apt.annotation.BodyContentDescription;
+<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.apache.myfaces.tobago.apt.annotation.Tag;
+<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.apache.myfaces.tobago.apt.annotation.TagAttribute;
+<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.apache.myfaces.tobago.apt.annotation.Taglib;
+<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
+<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
+<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
+<a name="33" href="#33">33</a>  
+<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> javax.annotation.processing.SupportedAnnotationTypes;
+<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> javax.annotation.processing.SupportedOptions;
+<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> javax.lang.model.element.ExecutableElement;
+<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> javax.lang.model.element.PackageElement;
+<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> javax.lang.model.element.TypeElement;
+<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> javax.tools.FileObject;
+<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> javax.tools.StandardLocation;
+<a name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> javax.xml.transform.OutputKeys;
+<a name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> javax.xml.transform.Transformer;
+<a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> javax.xml.transform.TransformerException;
+<a name="44" href="#44">44</a>  <strong class="jxr_keyword">import</strong> javax.xml.transform.TransformerFactory;
+<a name="45" href="#45">45</a>  <strong class="jxr_keyword">import</strong> javax.xml.transform.dom.DOMSource;
+<a name="46" href="#46">46</a>  <strong class="jxr_keyword">import</strong> javax.xml.transform.stream.StreamResult;
+<a name="47" href="#47">47</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="48" href="#48">48</a>  <strong class="jxr_keyword">import</strong> java.io.Writer;
+<a name="49" href="#49">49</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a name="50" href="#50">50</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
+<a name="51" href="#51">51</a>  
+<a name="52" href="#52">52</a>  @SupportedAnnotationTypes({
+<a name="53" href="#53">53</a>      <span class="jxr_string">"org.apache.myfaces.tobago.apt.annotation.Tag"</span>,
+<a name="54" href="#54">54</a>      <span class="jxr_string">"org.apache.myfaces.tobago.apt.annotation.TagAttribute"</span>,
+<a name="55" href="#55">55</a>      <span class="jxr_string">"org.apache.myfaces.tobago.apt.annotation.Taglib"</span>})
+<a name="56" href="#56">56</a>  @SupportedOptions({
+<a name="57" href="#57">57</a>      ReferenceGenerator.TARGET_REFERENCE})
+<a name="58" href="#58">58</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html">ReferenceGenerator</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/myfaces/tobago/apt/processor/TldGenerator.html">TldGenerator</a> {
+<a name="59" href="#59">59</a>  
+<a name="60" href="#60">60</a>    <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TARGET_REFERENCE = <span class="jxr_string">"targetReference"</span>;
+<a name="61" href="#61">61</a>  
+<a name="62" href="#62">62</a>    <strong class="jxr_keyword">private</strong> String targetReference;
+<a name="63" href="#63">63</a>  
+<a name="64" href="#64">64</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> configure() {
+<a name="65" href="#65">65</a>      <strong class="jxr_keyword">final</strong> Map&lt;String, String&gt; options = processingEnv.getOptions();
+<a name="66" href="#66">66</a>      targetReference = options.get(TARGET_REFERENCE);
+<a name="67" href="#67">67</a>  
+<a name="68" href="#68">68</a>      info(<span class="jxr_string">"Generating the tobago.xml"</span>);
+<a name="69" href="#69">69</a>      info(<span class="jxr_string">"Options:"</span>);
+<a name="70" href="#70">70</a>      info(TARGET_REFERENCE + <span class="jxr_string">": "</span> + targetReference);
+<a name="71" href="#71">71</a>    }
+<a name="72" href="#72">72</a>  
+<a name="73" href="#73">73</a>    @Override
+<a name="74" href="#74">74</a>    <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> writeTaglib(PackageElement packageElement, Taglib taglibAnnotation, Document document)
+<a name="75" href="#75">75</a>        <strong class="jxr_keyword">throws</strong> IOException, TransformerException {
+<a name="76" href="#76">76</a>      Writer writer = <strong class="jxr_keyword">null</strong>;
+<a name="77" href="#77">77</a>      <strong class="jxr_keyword">try</strong> {
+<a name="78" href="#78">78</a>        <strong class="jxr_keyword">final</strong> String file = taglibAnnotation.name() + <span class="jxr_string">".xml"</span>;
+<a name="79" href="#79">79</a>        <strong class="jxr_keyword">final</strong> String name = (StringUtils.isNotBlank(targetReference) ? targetReference + '/' : <span class="jxr_string">""</span>)
+<a name="80" href="#80">80</a>            + packageElement.getQualifiedName().toString().replace('.', '/') + '/' + file;
+<a name="81" href="#81">81</a>        <strong class="jxr_keyword">final</strong> FileObject resource = processingEnv.getFiler().createResource(StandardLocation.SOURCE_OUTPUT, <span class="jxr_string">""</span>, name);
+<a name="82" href="#82">82</a>        info(<span class="jxr_string">"Writing to file: "</span> + resource.toUri());
+<a name="83" href="#83">83</a>        writer = resource.openWriter();
+<a name="84" href="#84">84</a>  
+<a name="85" href="#85">85</a>        TransformerFactory transFactory = TransformerFactory.newInstance();
+<a name="86" href="#86">86</a>        transFactory.setAttribute(<span class="jxr_string">"indent-number"</span>, 2);
+<a name="87" href="#87">87</a>        Transformer transformer = transFactory.newTransformer();
+<a name="88" href="#88">88</a>        <em class="jxr_comment">// TODO transformer.setOutputProperty(OutputKeys.DOCTYPE_PUBLIC,</em>
+<a name="89" href="#89">89</a>        <em class="jxr_comment">//   "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN");</em>
+<a name="90" href="#90">90</a>        <em class="jxr_comment">// TODO transformer.setOutputProperty(OutputKeys.DOCTYPE_SYSTEM,</em>
+<a name="91" href="#91">91</a>        <em class="jxr_comment">//   "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd");</em>
+<a name="92" href="#92">92</a>        transformer.setOutputProperty(OutputKeys.METHOD, <span class="jxr_string">"xml"</span>);
+<a name="93" href="#93">93</a>        transformer.setOutputProperty(OutputKeys.INDENT, <span class="jxr_string">"yes"</span>);
+<a name="94" href="#94">94</a>        transformer.transform(<strong class="jxr_keyword">new</strong> DOMSource(document), <strong class="jxr_keyword">new</strong> StreamResult(writer));
+<a name="95" href="#95">95</a>      } <strong class="jxr_keyword">finally</strong> {
+<a name="96" href="#96">96</a>        IOUtils.closeQuietly(writer);
+<a name="97" href="#97">97</a>      }
+<a name="98" href="#98">98</a>    }
+<a name="99" href="#99">99</a>  
+<a name="100" href="#100">100</a>   @Override
+<a name="101" href="#101">101</a>   <strong class="jxr_keyword">protected</strong> Element createTag(
+<a name="102" href="#102">102</a>       TypeElement typeElement, Tag annotationTag, String className, Document document, <strong class="jxr_keyword">boolean</strong> deprecated) {
+<a name="103" href="#103">103</a>     Element tagElement = document.createElement(<span class="jxr_string">"tag"</span>);
+<a name="104" href="#104">104</a>     addDescription(typeElement, tagElement, document, false);
+<a name="105" href="#105">105</a>     addLeafTextElement(annotationTag.name(), <span class="jxr_string">"name"</span>, tagElement, document);
+<a name="106" href="#106">106</a>     addLeafTextElement(className, <span class="jxr_string">"tag-class"</span>, tagElement, document);
+<a name="107" href="#107">107</a> 
+<a name="108" href="#108">108</a>     BodyContent bodyContent = annotationTag.bodyContent();
+<a name="109" href="#109">109</a>     BodyContentDescription contentDescription = typeElement.getAnnotation(BodyContentDescription.<strong class="jxr_keyword">class</strong>);
+<a name="110" href="#110">110</a>     <em class="jxr_comment">// TODO more error checking</em>
+<a name="111" href="#111">111</a>     <strong class="jxr_keyword">if</strong> (contentDescription != <strong class="jxr_keyword">null</strong>) {
+<a name="112" href="#112">112</a>       <strong class="jxr_keyword">if</strong> (bodyContent.equals(BodyContent.JSP)
+<a name="113" href="#113">113</a>           &amp;&amp; contentDescription.contentType().length() &gt; 0) {
+<a name="114" href="#114">114</a>         <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
+<a name="115" href="#115">115</a>             <span class="jxr_string">"contentType "</span> + contentDescription.contentType() + <span class="jxr_string">" for bodyContent JSP not allowed!"</span>);
+<a name="116" href="#116">116</a>       } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (bodyContent.equals(BodyContent.TAGDEPENDENT)
+<a name="117" href="#117">117</a>           &amp;&amp; contentDescription.contentType().length() == 0) {
+<a name="118" href="#118">118</a>         <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"contentType should set for tag-dependent bodyContent"</span>);
+<a name="119" href="#119">119</a>       }
+<a name="120" href="#120">120</a>     }
+<a name="121" href="#121">121</a> 
+<a name="122" href="#122">122</a>     addLeafTextElement(bodyContent.toString(), <span class="jxr_string">"body-content"</span>, tagElement, document);
+<a name="123" href="#123">123</a>     <strong class="jxr_keyword">if</strong> (contentDescription != <strong class="jxr_keyword">null</strong>) {
+<a name="124" href="#124">124</a>       Element bodyContentDescription = document.createElement(<span class="jxr_string">"body-content-description"</span>);
+<a name="125" href="#125">125</a>       <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; contentDescription.anyClassOf().length; i++) {
+<a name="126" href="#126">126</a>         Element clazz = document.createElement(<span class="jxr_string">"class"</span>);
+<a name="127" href="#127">127</a>         String typeClass = contentDescription.anyClassOf()[i];
+<a name="128" href="#128">128</a>         addLeafTextElement(ClassUtils.getShortClassName(typeClass), <span class="jxr_string">"name"</span>, clazz, document);
+<a name="129" href="#129">129</a>         addLeafTextElement(ClassUtils.getPackageName(typeClass), <span class="jxr_string">"package"</span>, clazz, document);
+<a name="130" href="#130">130</a>         bodyContentDescription.appendChild(clazz);
+<a name="131" href="#131">131</a>       }
+<a name="132" href="#132">132</a>       <strong class="jxr_keyword">if</strong> (contentDescription.anyTagOf().length() &gt; 0) {
+<a name="133" href="#133">133</a>         addLeafTextElement(contentDescription.anyTagOf(), <span class="jxr_string">"tags"</span>, bodyContentDescription, document);
+<a name="134" href="#134">134</a>       }
+<a name="135" href="#135">135</a>       <strong class="jxr_keyword">if</strong> (contentDescription.contentType().length() &gt; 0) {
+<a name="136" href="#136">136</a>         addLeafTextElement(contentDescription.contentType(), <span class="jxr_string">"content-type"</span>, bodyContentDescription, document);
+<a name="137" href="#137">137</a>       }
+<a name="138" href="#138">138</a>       tagElement.appendChild(bodyContentDescription);
+<a name="139" href="#139">139</a>     }
+<a name="140" href="#140">140</a> 
+<a name="141" href="#141">141</a>     <strong class="jxr_keyword">return</strong> tagElement;
+<a name="142" href="#142">142</a>   }
+<a name="143" href="#143">143</a> 
+<a name="144" href="#144">144</a>   @Override
+<a name="145" href="#145">145</a>   <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addAttribute(ExecutableElement element, Element tagElement, Document document) {
+<a name="146" href="#146">146</a>     TagAttribute tagAttribute = element.getAnnotation(TagAttribute.<strong class="jxr_keyword">class</strong>);
+<a name="147" href="#147">147</a>     <strong class="jxr_keyword">if</strong> (tagAttribute != <strong class="jxr_keyword">null</strong>) {
+<a name="148" href="#148">148</a>       UIComponentTagAttribute uiTagAttribute = <strong class="jxr_keyword">null</strong>;
+<a name="149" href="#149">149</a>       <strong class="jxr_keyword">try</strong> {
+<a name="150" href="#150">150</a>         uiTagAttribute = element.getAnnotation(UIComponentTagAttribute.<strong class="jxr_keyword">class</strong>);
+<a name="151" href="#151">151</a>       } <strong class="jxr_keyword">catch</strong> (RuntimeException e) {
+<a name="152" href="#152">152</a>         e.printStackTrace();
+<a name="153" href="#153">153</a>       }
+<a name="154" href="#154">154</a>       String simpleName = element.getSimpleName().toString();
+<a name="155" href="#155">155</a>       <strong class="jxr_keyword">if</strong> (simpleName.startsWith(<span class="jxr_string">"set"</span>)) {
+<a name="156" href="#156">156</a>         Element attribute = document.createElement(<span class="jxr_string">"attribute"</span>);
+<a name="157" href="#157">157</a>         addDescription(element, attribute, document);
+<a name="158" href="#158">158</a>         addLeafTextElement(simpleName.substring(3, 4).toLowerCase(Locale.ENGLISH)
+<a name="159" href="#159">159</a>             + simpleName.substring(4), <span class="jxr_string">"name"</span>, attribute, document);
+<a name="160" href="#160">160</a>         addLeafTextElement(Boolean.toString(tagAttribute.required()), <span class="jxr_string">"required"</span>, attribute, document);
+<a name="161" href="#161">161</a>         addLeafTextElement(Boolean.toString(tagAttribute.rtexprvalue()), <span class="jxr_string">"rtexprvalue"</span>, attribute, document);
+<a name="162" href="#162">162</a>         <strong class="jxr_keyword">if</strong> (uiTagAttribute != <strong class="jxr_keyword">null</strong>) {
+<a name="163" href="#163">163</a>           addLeafTextElement(uiTagAttribute.expression().toString(), <span class="jxr_string">"ui-attribute-expression"</span>, attribute, document);
+<a name="164" href="#164">164</a> 
+<a name="165" href="#165">165</a>           String[] uiTypeClasses = uiTagAttribute.type();
+<a name="166" href="#166">166</a>           <strong class="jxr_keyword">if</strong> (uiTypeClasses.length &gt; 0) {
+<a name="167" href="#167">167</a>             Element uiAttributeType = document.createElement(<span class="jxr_string">"ui-attribute-type"</span>);
+<a name="168" href="#168">168</a>             <strong class="jxr_keyword">for</strong> (String typeClass : uiTypeClasses) {
+<a name="169" href="#169">169</a>               Element clazz = document.createElement(<span class="jxr_string">"class"</span>);
+<a name="170" href="#170">170</a>               addLeafTextElement(ClassUtils.getShortClassName(typeClass), <span class="jxr_string">"name"</span>, clazz, document);
+<a name="171" href="#171">171</a>               addLeafTextElement(ClassUtils.getPackageName(typeClass), <span class="jxr_string">"package"</span>, clazz, document);
+<a name="172" href="#172">172</a>               uiAttributeType.appendChild(clazz);
+<a name="173" href="#173">173</a>             }
+<a name="174" href="#174">174</a>             attribute.appendChild(uiAttributeType);
+<a name="175" href="#175">175</a>           }
+<a name="176" href="#176">176</a>           <strong class="jxr_keyword">if</strong> (uiTagAttribute.defaultValue().length() &gt; 0) {
+<a name="177" href="#177">177</a>             addLeafTextElement(uiTagAttribute.defaultValue(), <span class="jxr_string">"ui-attribute-default-value"</span>, attribute, document);
+<a name="178" href="#178">178</a>           }
+<a name="179" href="#179">179</a> 
+<a name="180" href="#180">180</a>         }
+<a name="181" href="#181">181</a> 
+<a name="182" href="#182">182</a>         tagElement.appendChild(attribute);
+<a name="183" href="#183">183</a>       } <strong class="jxr_keyword">else</strong> {
+<a name="184" href="#184">184</a>         <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Only setter allowed found: "</span> + simpleName);
+<a name="185" href="#185">185</a>       }
+<a name="186" href="#186">186</a>     }
+<a name="187" href="#187">187</a>   }
+<a name="188" href="#188">188</a> 
+<a name="189" href="#189">189</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt/xref/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: myfaces/site/publish/tobago/tobago-tool/tobago-tool-apt/xref/org/apache/myfaces/tobago/apt/processor/ReferenceGenerator.html
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL