| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.jena.annotation;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.juneau.jena.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>/**<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * Annotation for specifying options for RDF serializers.<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> *<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <p><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Can be used in the following locations:<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <ul><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <li>Marshalled classes/methods/fields/packages.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <li><ja>@Rest</ja>-annotated classes and <ja>@RestOp</ja>-annotated methods when an {@link #on()} value is specified.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * </ul><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <p><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Can be used for the following:<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <ul><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <li>Override the default behavior of how collections and arrays are serialized.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * </ul><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <ul class='seealso'><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li class='link'>{@doc jmr.RdfDetails}<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li class='extlink'>{@source}<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * </ul><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>@Documented<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>@Target({PACKAGE,TYPE,FIELD,METHOD})<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>@Retention(RUNTIME)<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>@Inherited<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>@Repeatable(RdfAnnotation.Array.class)<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>@ContextApply({RdfAnnotation.SerializerApplier.class,RdfAnnotation.ParserApplier.class})<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>public @interface Rdf {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Marks a bean property as a resource URI identifier for the bean.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <p><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Has the following effects on the following serializers:<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <ul class='spaced-list'><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <li><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * {@link RdfSerializer} - Will be rendered as the value of the <js>"rdf:about"</js> attribute<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * for the bean.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * </ul><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> *<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @return The annotation value.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> boolean beanUri() default false;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * The format for how collections (lists and arrays for example) are serialized in RDF.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @see RdfCollectionFormat<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return The annotation value.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> RdfCollectionFormat collectionFormat() default RdfCollectionFormat.DEFAULT;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Sets the namespace URI of this property or class.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <p><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Must be matched with a {@link #prefix() @Rdf(prefix)} annotation on this object, a parent object, or a {@link RdfNs @RdfNs} with the<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * same name through the {@link RdfSchema#rdfNs() @RdfSchema(rdfNs)} annotation on the package.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> *<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @return The annotation value.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> String namespace() default "";<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Dynamically apply this annotation to the specified classes/methods/fields.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <p><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Used in conjunction with {@link org.apache.juneau.BeanContext.Builder#applyAnnotations(Class...)} to dynamically apply an annotation to an existing class/method/field.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * It is ignored when the annotation is applied directly to classes/methods/fields.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> *<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <h5 class='section'>Valid patterns:</h5><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <ul class='spaced-list'><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * <li>Classes:<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * <ul><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * <li>Fully qualified:<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * <ul><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * <li><js>"com.foo.MyClass"</js><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * </ul><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <li>Fully qualified inner class:<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * <ul><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <li><js>"com.foo.MyClass$Inner1$Inner2"</js><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * </ul><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <li>Simple:<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <ul><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <li><js>"MyClass"</js><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * </ul><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * <li>Simple inner:<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <ul><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <li><js>"MyClass$Inner1$Inner2"</js><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * <li><js>"Inner1$Inner2"</js><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * <li><js>"Inner2"</js><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * </ul><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * </ul><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * <li>Methods:<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * <ul><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * <li>Fully qualified with args:<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <ul><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * <li><js>"com.foo.MyClass.myMethod(String,int)"</js><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <li><js>"com.foo.MyClass.myMethod(java.lang.String,int)"</js><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * <li><js>"com.foo.MyClass.myMethod()"</js><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * </ul><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <li>Fully qualified:<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <ul><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * <li><js>"com.foo.MyClass.myMethod"</js><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * </ul><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * <li>Simple with args:<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * <ul><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <li><js>"MyClass.myMethod(String,int)"</js><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * <li><js>"MyClass.myMethod(java.lang.String,int)"</js><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <li><js>"MyClass.myMethod()"</js><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * </ul><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * <li>Simple:<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * <ul><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <li><js>"MyClass.myMethod"</js><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * </ul><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * <li>Simple inner class:<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * <ul><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * <li><js>"MyClass$Inner1$Inner2.myMethod"</js><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * <li><js>"Inner1$Inner2.myMethod"</js><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <li><js>"Inner2.myMethod"</js><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * </ul><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * </ul><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * <li>Fields:<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * <ul><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * <li>Fully qualified:<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * <ul><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * <li><js>"com.foo.MyClass.myField"</js><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * </ul><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * <li>Simple:<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * <ul><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * <li><js>"MyClass.myField"</js><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * </ul><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * <li>Simple inner class:<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <ul><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * <li><js>"MyClass$Inner1$Inner2.myField"</js><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * <li><js>"Inner1$Inner2.myField"</js><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * <li><js>"Inner2.myField"</js><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * </ul><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * </ul><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * <li>A comma-delimited list of anything on this list.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * </ul><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> *<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * <ul class='seealso'><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * <li class='link'>{@doc jm.DynamicallyAppliedAnnotations}<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * </ul><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> *<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return The annotation value.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> String[] on() default {};<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /**<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * Dynamically apply this annotation to the specified classes.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> *<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * <p><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * Identical to {@link #on()} except allows you to specify class objects instead of a strings.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> *<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * <ul class='seealso'><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * <li class='link'>{@doc jm.DynamicallyAppliedAnnotations}<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * </ul><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> *<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @return The annotation value.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> */<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> Class<?>[] onClass() default {};<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> /**<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * Sets the XML prefix of this property or class.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> *<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * <p><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * Must either be matched to a {@link #namespace() @Rdf(namespace)} annotation on the same object, parent object, or a {@link RdfNs @RdfNs}<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * with the same name through the {@link RdfSchema#rdfNs() @RdfSchema(rdfNs)} annotation on the package.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> *<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @return The annotation value.<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> */<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> String prefix() default "";<a name="line.196"></a> |
| <span class="sourceLineNo">197</span>}<a name="line.197"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
