http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/BeanConstructor.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/BeanConstructor.html b/content/apidocs/org/apache/juneau/annotation/BeanConstructor.html deleted file mode 100644 index 2e53937..0000000 --- a/content/apidocs/org/apache/juneau/annotation/BeanConstructor.html +++ /dev/null @@ -1,277 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>BeanConstructor (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BeanConstructor (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/BeanConstructor.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/BeanConstructor.html" target="_top">Frames</a></li> -<li><a href="BeanConstructor.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type BeanConstructor" class="title">Annotation Type BeanConstructor</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCTOR" title="class or interface in java.lang.annotation">CONSTRUCTOR</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanConstructor.html#line.78">BeanConstructor</a></pre> -<div class="block">Maps constructor arguments to property names on beans with read-only properties. - <p> - This annotation can be used in the case of beans with properties whose values can only be set by passing - them in through a constructor on the class.<br> - Since method parameter names are lost during compilation, this annotation essentially redefines them - so that they are available at runtime. - <p> - The definition of a read-only bean is a bean with properties with only getters, like shown below... - <p class='bcode'> - <jk>public class</jk> Person { - <jk>private final</jk> String <jf>name</jf>; - <jk>private final int</jk> <jf>age</jf>; - - <ja>@BeanConstructor</ja>(properties={<js>"name"</js>,<js>"age"</js>}) - <jk>public</jk> Person(String name, <jk>int</jk> age) { - <jk>this</jk>.<jf>name</jf> = name; - <jk>this</jk>.<jf>age</jf> = age; - } - - <jc>// Read only properties.</jc> - - <jk>public</jk> String getName() { - <jk>return</jk> <jf>name</jf>; - } - - <jk>public int</jk> getAge() { - <jk>return</jk> <jf>age</jf>; - } - } - - String json = <js>"{name:'John Smith',age:45}"</js>; - Person p = JsonParser.<jsf>DEFAULT</jsf>.parse(json); - String name = p.getName(); <jc>// "John Smith"</jc> - <jk>int</jk> age = p.getAge(); <jc>// 45</jc> - </p> - <p> - This annotation can only be applied to constructors and can only be applied to one constructor per class. - <p> - When present, bean instantiation is delayed until the call to <a href="../../../../org/apache/juneau/BeanMap.html#getBean--"><code>BeanMap.getBean()</code></a>. - Until then, bean property values are stored in a local cache until <code>getBean()</code> is called. - Because of this additional caching step, parsing into read-only beans tends to be slower and use - more memory than parsing into beans with writable properties. - <p> - Attempting to call <a href="../../../../org/apache/juneau/BeanMap.html#put-java.lang.String-java.lang.Object-"><code>BeanMap.put(String,Object)</code></a> on a read-only property after calling <a href="../../../../org/apache/juneau/BeanMap.html#getBean--"><code>BeanMap.getBean()</code></a> - will result in a <a href="../../../../org/apache/juneau/BeanRuntimeException.html" title="class in org.apache.juneau"><code>BeanRuntimeException</code></a> being thrown. - Multiple calls to <a href="../../../../org/apache/juneau/BeanMap.html#getBean--"><code>BeanMap.getBean()</code></a> will return the same bean instance. - <p> - Beans can be defined with a combination of read-only and read-write properties.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.optional.element.summary"> -<!-- --> -</a> -<h3>Optional Element Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> -<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Optional Element and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanConstructor.html#properties--">properties</a></span></code> -<div class="block">The names of the properties of the constructor arguments.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.element.detail"> -<!-- --> -</a> -<h3>Element Detail</h3> -<a name="properties--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>properties</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanConstructor.html#line.85">properties</a></pre> -<div class="block">The names of the properties of the constructor arguments. - <p> - The number of properties listed must match the number of arguments in the constructor.</div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/BeanConstructor.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/BeanConstructor.html" target="_top">Frames</a></li> -<li><a href="BeanConstructor.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/BeanIgnore.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/BeanIgnore.html b/content/apidocs/org/apache/juneau/annotation/BeanIgnore.html deleted file mode 100644 index d90725f..0000000 --- a/content/apidocs/org/apache/juneau/annotation/BeanIgnore.html +++ /dev/null @@ -1,181 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>BeanIgnore (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BeanIgnore (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/BeanIgnore.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/BeanConstructor.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/BeanProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/BeanIgnore.html" target="_top">Frames</a></li> -<li><a href="BeanIgnore.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type BeanIgnore" class="title">Annotation Type BeanIgnore</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>}) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanIgnore.html#line.37">BeanIgnore</a></pre> -<div class="block">Ignore classes, fields, and methods from being interpreted as bean or bean components. - <p> - Applied to classes that may look like beans, but you want to be treated as non-beans. - For example, if you want to force a bean to be converted to a string using the <code>toString()</code> - method, use this annoation on the class. - <p> - Applies to fields that should not be interpreted as bean property fields. - <p> - Applies to getters or setters that should not be interpreted as bean property getters or setters.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/BeanIgnore.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/BeanConstructor.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/BeanProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/BeanIgnore.html" target="_top">Frames</a></li> -<li><a href="BeanIgnore.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/BeanProperty.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/BeanProperty.html b/content/apidocs/org/apache/juneau/annotation/BeanProperty.html deleted file mode 100644 index 532b440..0000000 --- a/content/apidocs/org/apache/juneau/annotation/BeanProperty.html +++ /dev/null @@ -1,466 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>BeanProperty (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BeanProperty (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/BeanProperty.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/Consumes.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/BeanProperty.html" target="_top">Frames</a></li> -<li><a href="BeanProperty.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type BeanProperty" class="title">Annotation Type BeanProperty</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>}) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.49">BeanProperty</a></pre> -<div class="block">Used tailor how bean properties get interpreted by the framework. - <p> - Can be used to do the following: - <ul class='spaced-list'> - <li>Override the name of a property. - <li>Identify a getter or setter with a non-standard naming convention. - <li>Identify a specific subclass for a property with a general class type. - <li>Identify class types of elements in properties of type <code>Collection</code> or <code>Map</code>. - <li>Hide properties during serialization. - <li>Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field to a string. - <li>Override the list of properties during serialization on child elements of a property of type <code>Collection</code> or <code>Map</code>. - <li>Identify a property as the URL for a bean. - <li>Identify a property as the ID for a bean. - </ul> - <p> - This annotation is applied to public fields and public getter/setter methods of beans.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.optional.element.summary"> -<!-- --> -</a> -<h3>Optional Element Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> -<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Optional Element and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#beanDictionary--">beanDictionary</a></span></code> -<div class="block">The list of classes that make up the bean dictionary for this bean property.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#name--">name</a></span></code> -<div class="block">Identifies the name of the property.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#params--">params</a></span></code> -<div class="block">For bean properties of maps and collections, this annotation can be used to identify - the class types of the contents of the bean property object when the generic parameter - types are interfaces or abstract classes.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#properties--">properties</a></span></code> -<div class="block">Used to limit which child properties are rendered by the serializers.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#swap--">swap</a></span></code> -<div class="block">Associates a <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> or <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a> with this bean property that will swap the value object - with another object during serialization and parsing.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#type--">type</a></span></code> -<div class="block">Identifies a specialized class type for the property.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.element.detail"> -<!-- --> -</a> -<h3>Element Detail</h3> -<a name="name--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>name</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.61">name</a></pre> -<div class="block">Identifies the name of the property. - <p> - Normally, this is automatically inferred from the field name or getter method name - of the property. However, this property can be used to assign a different - property name from the automatically inferred value. - <p> - If the <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanFieldVisibility"><code>BeanContext.BEAN_beanFieldVisibility</code></a> setting on the bean context excludes this field (e.g. the visibility - is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be identified as a property.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="type--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>type</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.87">type</a></pre> -<div class="block">Identifies a specialized class type for the property. - <p> - Normally this can be inferred through reflection of the field type or getter return type. - However, you'll want to specify this value if you're parsing beans where the bean property class - is an interface or abstract class to identify the bean type to instantiate. Otherwise, you may - cause an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InstantiationException.html?is-external=true" title="class or interface in java.lang"><code>InstantiationException</code></a> when trying to set these fields. - <p> - This property must denote a concrete bean class with a no-arg constructor. - - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> - <jk>public class</jk> MyBean { - - <jc>// Identify concrete map type.</jc> - <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>) - <jk>public</jk> Map <jf>p1</jf>; - } - </p> - </dd> - </dl></div> -<dl> -<dt>Default:</dt> -<dd>java.lang.Object.class</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="params--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>params</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.108">params</a></pre> -<div class="block">For bean properties of maps and collections, this annotation can be used to identify - the class types of the contents of the bean property object when the generic parameter - types are interfaces or abstract classes. - - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> - <jk>public class</jk> MyBean { - - <jc>// Identify concrete map type with String keys and Integer values.</jc> - <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>, params={String.<jk>class</jk>,Integer.<jk>class</jk>}) - <jk>public</jk> Map <jf>p1</jf>; - } - </p> - </dd> - </dl></div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="swap--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>swap</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.134">swap</a></pre> -<div class="block">Associates a <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> or <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a> with this bean property that will swap the value object - with another object during serialization and parsing. - <p> - This annotation supersedes any swaps associated with the bean property type - class itself. - <p> - Typically used for rendering <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Dates</code></a> and <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendars</code></a> - as a particular string format. - - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> - <jk>public class</jk> MyClass { - - <jc>// During serialization, convert to ISO8601 date-time string.</jc> - <ja>@BeanProperty</ja>(pojoSwap=CalendarSwap.ISO8601DT.<jk>class</jk>) - <jk>public</jk> Calendar getTime(); - } - </p> - </dd> - </dl></div> -<dl> -<dt>Default:</dt> -<dd>org.apache.juneau.internal.Null.class</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="properties--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>properties</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.169">properties</a></pre> -<div class="block">Used to limit which child properties are rendered by the serializers. - <p> - Can be used on any of the following bean property types: - <ul class='spaced-list'> - <li>Beans - Only render the specified properties of the bean. - <li>Maps - Only render the specified entries in the map. - <li>Bean/Map arrays - Same, but applied to each element in the array. - <li>Bean/Map collections - Same, but applied to each element in the collection. - </ul> - - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> - <jk>public class</jk> MyClass { - - <jc>// Only render 'f1' when serializing this bean property.</jc> - <ja>@BeanProperty</ja>(properties={<js>"f1"</js>}) - <jk>public</jk> MyChildClass x1 = <jk>new</jk> MyChildClass(); - } - - <jk>public class</jk> MyChildClass { - <jk>public int</jk> f1 = 1; - <jk>public int</jk> f2 = 2; - } - - <jc>// Renders "{x1:{f1:1}}"</jc> - String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(<jk>new</jk> MyClass()); - </p> - </dd> - </dl></div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="beanDictionary--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>beanDictionary</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.184">beanDictionary</a></pre> -<div class="block">The list of classes that make up the bean dictionary for this bean property. - <p> - The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred through reflection. - The names are defined through the <a href="../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean.typeName()</code></a> annotation defined on the bean class. - <p> - This list can consist of the following class types: - <ul> - <li>Any bean class that specifies a value for <a href="../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>@Bean.name()</code></a>; - <li>Any subclass of <a href="../../../../org/apache/juneau/BeanDictionaryBuilder.html" title="class in org.apache.juneau"><code>BeanDictionaryBuilder</code></a> that defines an entire set of mappings. - Note that the subclass MUST implement a no-arg constructor so that it can be instantiated. - </ul></div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/BeanProperty.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/Consumes.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/BeanProperty.html" target="_top">Frames</a></li> -<li><a href="BeanProperty.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/Consumes.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/Consumes.html b/content/apidocs/org/apache/juneau/annotation/Consumes.html deleted file mode 100644 index f691fdd..0000000 --- a/content/apidocs/org/apache/juneau/annotation/Consumes.html +++ /dev/null @@ -1,266 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Consumes (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Consumes (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/Consumes.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/BeanProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/NameProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/Consumes.html" target="_top">Frames</a></li> -<li><a href="Consumes.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type Consumes" class="title">Annotation Type Consumes</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Consumes.html#line.63">Consumes</a></pre> -<div class="block">Annotation used on subclasses of <a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> to identify the media types that it consumes. - - - <h6 class='topic'>Description</h6> - <p> - Provides a way to define the contents of <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> through an annotation. - <p> - The <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> default implementation gathers the media types by looking - for this annotation. - It should be noted that this annotation is optional and that the <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> method can - be overridden by subclasses to return the media types programmatically. - - - <h6 class='topic'>Examples</h6> - <p> - Standard example: - <p class='bcode'> - <ja>@Consumes</ja>({<js>"application/json"</js>,<js>"text/json"</js>}) - <jk>public class</jk> JsonParser <jk>extends</jk> ReaderParser {...} - </p> - <p> - The media types can also be <code>media-range</code> values per - <a href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1'>RFC2616/14.1</a>. - <p class='bcode'> - <jc>// Consumes any text</jc> - <ja>@Consumes</ja>({<js>"text\/*"</js>}) - <jk>public class</jk> AnythingParser <jk>extends</jk> ReaderParser {...} - - <jc>// Consumes anything</jc> - <ja>@Consumes</ja>({<js>"*\/*"</js>}) - <jk>public class</jk> AnythingParser <jk>extends</jk> ReaderParser {...} - </p></div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.optional.element.summary"> -<!-- --> -</a> -<h3>Optional Element Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> -<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Optional Element and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Consumes.html#value--">value</a></span></code> -<div class="block">The media types that the parser can handle.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.element.detail"> -<!-- --> -</a> -<h3>Element Detail</h3> -<a name="value--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>value</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/juneau/annotation/Consumes.html#line.72">value</a></pre> -<div class="block">The media types that the parser can handle. - <p> - Can contain meta-characters per the <code>media-type</code> specification of - <a href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1'>RFC2616/14.1</a></div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The media types that the parser can handle.</dd> -</dl> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/Consumes.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/BeanProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/NameProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/Consumes.html" target="_top">Frames</a></li> -<li><a href="Consumes.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/NameProperty.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/NameProperty.html b/content/apidocs/org/apache/juneau/annotation/NameProperty.html deleted file mode 100644 index e1448d4..0000000 --- a/content/apidocs/org/apache/juneau/annotation/NameProperty.html +++ /dev/null @@ -1,177 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NameProperty (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="NameProperty (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/NameProperty.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/Consumes.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/ParentProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/NameProperty.html" target="_top">Frames</a></li> -<li><a href="NameProperty.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type NameProperty" class="title">Annotation Type NameProperty</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/NameProperty.html#line.35">NameProperty</a></pre> -<div class="block">Identifies a setter as a method for setting the name of a POJO as it's known by - its parent object. - <p> - For example, the <a href="../../../../org/apache/juneau/ini/Section.html" title="class in org.apache.juneau.ini"><code>Section</code></a> class must know the name it's known by it's parent - <a href="../../../../org/apache/juneau/ini/ConfigFileImpl.html" title="class in org.apache.juneau.ini"><code>ConfigFileImpl</code></a> class, so parsers will call this method with the section name - using the <a href="../../../../org/apache/juneau/ini/Section.html#setName-java.lang.String-"><code>Section.setName(String)</code></a> method.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/NameProperty.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/Consumes.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/ParentProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/NameProperty.html" target="_top">Frames</a></li> -<li><a href="NameProperty.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/ParentProperty.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/ParentProperty.html b/content/apidocs/org/apache/juneau/annotation/ParentProperty.html deleted file mode 100644 index 42d1269..0000000 --- a/content/apidocs/org/apache/juneau/annotation/ParentProperty.html +++ /dev/null @@ -1,177 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>ParentProperty (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ParentProperty (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/ParentProperty.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/NameProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/Pojo.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/ParentProperty.html" target="_top">Frames</a></li> -<li><a href="ParentProperty.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type ParentProperty" class="title">Annotation Type ParentProperty</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/ParentProperty.html#line.35">ParentProperty</a></pre> -<div class="block">Identifies a setter as a method for adding a parent reference to a child object. - <p> - Used by the parsers to add references to parent objects in child objects. - For example, the <a href="../../../../org/apache/juneau/ini/Section.html" title="class in org.apache.juneau.ini"><code>Section</code></a> class cannot exist outside the scope of a parent - <a href="../../../../org/apache/juneau/ini/ConfigFileImpl.html" title="class in org.apache.juneau.ini"><code>ConfigFileImpl</code></a> class, so parsers will add a reference to the config file - using the <a href="../../../../org/apache/juneau/ini/Section.html#setParent-org.apache.juneau.ini.ConfigFileImpl-"><code>Section.setParent(ConfigFileImpl)</code></a> method.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/ParentProperty.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/NameProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/Pojo.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/ParentProperty.html" target="_top">Frames</a></li> -<li><a href="ParentProperty.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li>Optional</li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Element</li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/081b41e6/content/apidocs/org/apache/juneau/annotation/Pojo.html ---------------------------------------------------------------------- diff --git a/content/apidocs/org/apache/juneau/annotation/Pojo.html b/content/apidocs/org/apache/juneau/annotation/Pojo.html deleted file mode 100644 index 6cf4bff..0000000 --- a/content/apidocs/org/apache/juneau/annotation/Pojo.html +++ /dev/null @@ -1,276 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Pojo (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</title> -<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Pojo (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; - } - } - catch(err) { - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/Pojo.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/ParentProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/Produces.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/Pojo.html" target="_top">Frames</a></li> -<li><a href="Pojo.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.juneau.annotation</div> -<h2 title="Annotation Type Pojo" class="title">Annotation Type Pojo</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) - <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true" title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pojo.html#line.32">Pojo</a></pre> -<div class="block">Used to tailor how POJOs get interpreted by the framework.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>James Bognar (james.bog...@salesforce.com)</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.optional.element.summary"> -<!-- --> -</a> -<h3>Optional Element Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> -<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Optional Element and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Pojo.html#swap--">swap</a></span></code> -<div class="block">Associate a <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> or <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a> with this class type.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="annotation.type.element.detail"> -<!-- --> -</a> -<h3>Element Detail</h3> -<a name="swap--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>swap</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/Pojo.html#line.85">swap</a></pre> -<div class="block">Associate a <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> or <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a> with this class type. - - <p> - Supports the following class types: - <ul> - <li>Subclasses of <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a>. - <li>Any other class. Will get interpreted as a <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a>. - </ul> - - <h6 class='topic'>Example</h6> - <p> - In this case, a swap is being applied to a bean that will force it to be serialized as a <code>String</code> - <p class='bcode'> - <jc>// Our bean class</jc> - <ja>@Pojo</ja>(swap=BSwap.<jk>class</jk>) - <jk>public class</jk> B { - <jk>public</jk> String <jf>f1</jf>; - } - - <jc>// Our POJO swap to force the bean to be serialized as a String</jc> - <jk>public class</jk> BSwap <jk>extends</jk> PojoSwap<B,String> { - <jk>public</jk> String swap(B o) <jk>throws</jk> SerializeException { - <jk>return</jk> o.f1; - } - <jk>public</jk> B unswap(String f) <jk>throws</jk> ParseException { - B b1 = <jk>new</jk> B(); - b1.<jf>f1</jf> = f; - <jk>return</jk> b1; - } - } - - <jk>public void</jk> test() <jk>throws</jk> Exception { - WriterSerializer s = JsonSerializer.<jsf>DEFAULT</jsf>; - B b = <jk>new</jk> B(); - b.<jf>f1</jf> = <js>"bar"</js>; - String json = s.serialize(b); - <jsm>assertEquals</jsm>(<js>"'bar'"</js>, json); - - ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>; - b = p.parse(json, B.<jk>class</jk>); - <jsm>assertEquals</jsm>(<js>"bar"</js>, t.<jf>f1</jf>); - } - </p> - <p> - Note that using this annotation is functionally equivalent to adding swaps to the serializers and parsers: - <p class='bcode'> - WriterSerializer s = <jk>new</jk> JsonSerializer.addPojoSwaps(BSwap.<jk>class</jk>); - ReaderParser p = <jk>new</jk> JsonParser.addPojoSwaps(BSwap.<jk>class</jk>); - </p></div> -<dl> -<dt>Default:</dt> -<dd>org.apache.juneau.internal.Null.class</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/Pojo.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/juneau/annotation/ParentProperty.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/annotation/Produces.html" title="annotation in org.apache.juneau.annotation"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/juneau/annotation/Pojo.html" target="_top">Frames</a></li> -<li><a href="Pojo.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Field | </li> -<li>Required | </li> -<li><a href="#annotation.type.optional.element.summary">Optional</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#annotation.type.element.detail">Element</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p> -</body> -</html>