http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/Visibility.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/Visibility.html b/content/api-documentation/org/apache/juneau/Visibility.html new file mode 100644 index 0000000..22cc0f5 --- /dev/null +++ b/content/api-documentation/org/apache/juneau/Visibility.html @@ -0,0 +1,638 @@ +<!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 --> +<title>Visibility (Juneau)</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="Visibility (Juneau)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":9,"i11":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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/Visibility.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/Streamable.html" title="interface in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/juneau/Writable.html" title="interface in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/juneau/Visibility.html" target="_top">Frames</a></li> +<li><a href="Visibility.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>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</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</div> +<h2 title="Enum Visibility" class="title">Enum Visibility</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.Visibility</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <a href="../../../src-html/org/apache/juneau/Visibility.html#line.31">Visibility</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>></pre> +<div class="block">Defines class/field/method visibilities. + <p> + Used to specify minimum levels of visibility when detecting bean classes, methods, and fields. + Used in conjunction with the following bean context properties: + <ul> + <li><a href="../../../org/apache/juneau/BeanContext.html#BEAN_beanConstructorVisibility"><code>BeanContext.BEAN_beanConstructorVisibility</code></a> + <li><a href="../../../org/apache/juneau/BeanContext.html#BEAN_beanClassVisibility"><code>BeanContext.BEAN_beanClassVisibility</code></a> + <li><a href="../../../org/apache/juneau/BeanContext.html#BEAN_beanFieldVisibility"><code>BeanContext.BEAN_beanFieldVisibility</code></a> + <li><a href="../../../org/apache/juneau/BeanContext.html#BEAN_methodVisibility"><code>BeanContext.BEAN_methodVisibility</code></a> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>James Bognar ([email protected])</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#DEFAULT">DEFAULT</a></span></code> +<div class="block">Include all but <jk>private</jk> classes/fields/methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#NONE">NONE</a></span></code> +<div class="block">Ignore all</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#PRIVATE">PRIVATE</a></span></code> +<div class="block">Include all classes/fields/methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#PROTECTED">PROTECTED</a></span></code> +<div class="block">Include only <jk>public</jk> or <jk>protected</jk> classes/fields/methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#PUBLIC">PUBLIC</a></span></code> +<div class="block">Include only <jk>public</jk> classes/fields/methods.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#isVisible-java.lang.reflect.Constructor-">isVisible</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</code> +<div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#isVisible-java.lang.reflect.Field-">isVisible</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</code> +<div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#isVisible-int-">isVisible</a></span>(int mod)</code> +<div class="block">Identifies if the specified mod matches this visibility.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#isVisible-java.lang.reflect.Method-">isVisible</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</code> +<div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#setAccessible-java.lang.reflect.Constructor-">setAccessible</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</code> +<div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#setAccessible-java.lang.reflect.Field-">setAccessible</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</code> +<div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#setAccessible-java.lang.reflect.Method-">setAccessible</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</code> +<div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#transform-java.lang.reflect.Constructor-">transform</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> x)</code> +<div class="block">Makes constructor accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#transform-java.lang.reflect.Field-">transform</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</code> +<div class="block">Makes field accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#transform-java.lang.reflect.Method-">transform</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</code> +<div class="block">Makes method accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#valueOf-java.lang.String-">valueOf</a></span>(<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> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Visibility.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-"; title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--"; title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--"; title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-"; title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="NONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NONE</h4> +<pre>public static final <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.34">NONE</a></pre> +<div class="block">Ignore all</div> +</li> +</ul> +<a name="PUBLIC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PUBLIC</h4> +<pre>public static final <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.37">PUBLIC</a></pre> +<div class="block">Include only <jk>public</jk> classes/fields/methods.</div> +</li> +</ul> +<a name="PROTECTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROTECTED</h4> +<pre>public static final <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.40">PROTECTED</a></pre> +<div class="block">Include only <jk>public</jk> or <jk>protected</jk> classes/fields/methods.</div> +</li> +</ul> +<a name="DEFAULT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT</h4> +<pre>public static final <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.43">DEFAULT</a></pre> +<div class="block">Include all but <jk>private</jk> classes/fields/methods.</div> +</li> +</ul> +<a name="PRIVATE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PRIVATE</h4> +<pre>public static final <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.46">PRIVATE</a></pre> +<div class="block">Include all classes/fields/methods.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>[] <a href="../../../src-html/org/apache/juneau/Visibility.html#line.39">values</a>()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Visibility c : Visibility.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.39">valueOf</a>(<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> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</li> +</ul> +<a name="isVisible-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVisible</h4> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.61">isVisible</a>(int mod)</pre> +<div class="block">Identifies if the specified mod matches this visibility. + Example: + <code> + <jsf>PUBLIC</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//true</jk> + <jsf>PUBLIC</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//false</jk> + <jsf>PRIVATE</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//true</jk> + <jsf>NONE</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//false</jk> + </code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mod</code> - The modifier from the object being tested (e.g. results from <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true#getModifiers--"; title="class or interface in java.lang"><code>Class.getModifiers()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if this visibility matches the specified modifier attribute.</dd> +</dl> +</li> +</ul> +<a name="isVisible-java.lang.reflect.Constructor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVisible</h4> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.77">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</pre> +<div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The constructor to check.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if the constructor is at least as visible as this object.</dd> +</dl> +</li> +</ul> +<a name="isVisible-java.lang.reflect.Method-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVisible</h4> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.87">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> +<div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The method to check.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if the method is at least as visible as this object.</dd> +</dl> +</li> +</ul> +<a name="isVisible-java.lang.reflect.Field-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVisible</h4> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.97">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> +<div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The field to check.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if the field is at least as visible as this object.</dd> +</dl> +</li> +</ul> +<a name="transform-java.lang.reflect.Constructor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transform</h4> +<pre>public <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.109">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> x)</pre> +<div class="block">Makes constructor accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't. + Security exceptions thrown on the call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> are quietly ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The constructor.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The same constructor if visibility requirements met, or <jk>null</jk> if visibility requirement not + met or call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> throws a security exception.</dd> +</dl> +</li> +</ul> +<a name="transform-java.lang.reflect.Method-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transform</h4> +<pre>public <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.126">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> +<div class="block">Makes method accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't. + Security exceptions thrown on the call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> are quietly ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The method.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The same method if visibility requirements met, or <jk>null</jk> if visibility requirement not + met or call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> throws a security exception.</dd> +</dl> +</li> +</ul> +<a name="transform-java.lang.reflect.Field-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transform</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.143">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> +<div class="block">Makes field accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't. + Security exceptions thrown on the call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> are quietly ignored.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The field.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The same field if visibility requirements met, or <jk>null</jk> if visibility requirement not + met or call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> throws a security exception.</dd> +</dl> +</li> +</ul> +<a name="setAccessible-java.lang.reflect.Constructor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAccessible</h4> +<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.158">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</pre> +<div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The constructor.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if call was successful.</dd> +</dl> +</li> +</ul> +<a name="setAccessible-java.lang.reflect.Method-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAccessible</h4> +<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.174">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> +<div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The method.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if call was successful.</dd> +</dl> +</li> +</ul> +<a name="setAccessible-java.lang.reflect.Field-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setAccessible</h4> +<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.190">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> +<div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - The field.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><jk>true</jk> if call was successful.</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/Visibility.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/Streamable.html" title="interface in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/juneau/Writable.html" title="interface in org.apache.juneau"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/juneau/Visibility.html" target="_top">Frames</a></li> +<li><a href="Visibility.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>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/Writable.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/Writable.html b/content/api-documentation/org/apache/juneau/Writable.html new file mode 100644 index 0000000..4ab214b --- /dev/null +++ b/content/api-documentation/org/apache/juneau/Writable.html @@ -0,0 +1,263 @@ +<!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 --> +<title>Writable (Juneau)</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="Writable (Juneau)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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/Writable.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/Visibility.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/juneau/Writable.html" target="_top">Frames</a></li> +<li><a href="Writable.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>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</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</div> +<h2 title="Interface Writable" class="title">Interface Writable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/juneau/server/ReaderResource.html" title="class in org.apache.juneau.server">ReaderResource</a>, <a href="../../../org/apache/juneau/serializer/StringObject.html" title="class in org.apache.juneau.serializer">StringObject</a></dd> +</dl> +<hr> +<br> +<pre>public interface <a href="../../../src-html/org/apache/juneau/Writable.html#line.26">Writable</a></pre> +<div class="block">Interface that identifies that an object can be serialized directly to a writer. + <p> + Instances must identify the media type of the content by implementing the + <a href="../../../org/apache/juneau/Writable.html#getMediaType--"><code>getMediaType()</code></a> method. + </p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>James Bognar ([email protected])</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" 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/Writable.html#getMediaType--">getMediaType</a></span>()</code> +<div class="block">Returns the serialized media type for this resource (e.g.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/Writable.html#writeTo-java.io.Writer-">writeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> w)</code> +<div class="block">Serialize this object to the specified writer.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="writeTo-java.io.Writer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeTo</h4> +<pre>void <a href="../../../src-html/org/apache/juneau/Writable.html#line.34">writeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> w) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Serialize this object to the specified writer.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>w</code> - The writer to write to.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="getMediaType--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMediaType</h4> +<pre><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/Writable.html#line.41">getMediaType</a>()</pre> +<div class="block">Returns the serialized media type for this resource (e.g. <js>"text/html"</js>)</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The media type, or <jk>null</jk> if the media type is not known.</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/Writable.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/Visibility.html" title="enum in org.apache.juneau"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/juneau/Writable.html" target="_top">Frames</a></li> +<li><a href="Writable.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>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/annotation/Bean.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/annotation/Bean.html b/content/api-documentation/org/apache/juneau/annotation/Bean.html new file mode 100644 index 0000000..8edcf08 --- /dev/null +++ b/content/api-documentation/org/apache/juneau/annotation/Bean.html @@ -0,0 +1,549 @@ +<!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 --> +<title>Bean (Juneau)</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="Bean (Juneau)"; + } + } + 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/Bean.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>Prev Class</li> +<li><a href="../../../../org/apache/juneau/annotation/BeanConstructor.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/Bean.html" target="_top">Frames</a></li> +<li><a href="Bean.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 Bean" class="title">Annotation Type Bean</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/Bean.html#line.42">Bean</a></pre> +<div class="block">Used to tailor how beans get interpreted by the framework. + <p> + Can be used to do the following: + <ul class='spaced-list'> + <li>Explicitly specify the set and order of properties on a bean. + <li>Associate a <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau"><code>PropertyNamer</code></a> with a class. + <li>Specify subtypes of a bean differentiated by a sub type property. + </ul> + <p> + This annotation can be applied to classes and interfaces.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>James Bognar ([email protected])</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/Bean.html#excludeProperties--">excludeProperties</a></span></code> +<div class="block">Specifies a list of properties that should be excluded from <a href="../../../../org/apache/juneau/BeanMap.html#entrySet--"><code>BeanMap.entrySet()</code></a>.</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/Bean.html#interfaceClass--">interfaceClass</a></span></code> +<div class="block">Identifies a class to be used as the interface class for this and all subclasses.</div> +</td> +</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/Bean.html#properties--">properties</a></span></code> +<div class="block">The set and order of names of properties associated with a bean class.</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><? extends <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Bean.html#propertyNamer--">propertyNamer</a></span></code> +<div class="block">Associates a <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau"><code>PropertyNamer</code></a> with this bean to tailor the names of the bean properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Bean.html#sort--">sort</a></span></code> +<div class="block">Sort bean properties in alphabetical order.</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/Bean.html#stopClass--">stopClass</a></span></code> +<div class="block">Identifies a stop class for the annotated class.</div> +</td> +</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/Bean.html#subTypeProperty--">subTypeProperty</a></span></code> +<div class="block">Defines a virtual property on a superclass that identifies bean subtype classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/annotation/BeanSubType.html" title="annotation in org.apache.juneau.annotation">BeanSubType</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Bean.html#subTypes--">subTypes</a></span></code> +<div class="block">Used in conjunction with <a href="../../../../org/apache/juneau/annotation/Bean.html#subTypeProperty--"><code>subTypeProperty()</code></a> to set up bean subtypes.</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="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/Bean.html#line.64">properties</a></pre> +<div class="block">The set and order of names of properties associated with a bean class. + <p> + The order specified is the same order that the entries will be returned by the <a href="../../../../org/apache/juneau/BeanMap.html#entrySet--"><code>BeanMap.entrySet()</code></a> and related methods. + <p> + This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanTransform.html" title="class in org.apache.juneau.transform"><code>BeanTransform</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanTransform.html#getProperties--"><code>BeanTransform.getProperties()</code></a> method. + + <dl> + <dt>Example:</dt> + <dd> + <p class='bcode'> + <jc>// Address class with only street/city/state properties (in that order).</jc> + <jc>// All other properties are ignored.</jc> + <ja>@Bean</ja>(properties={<js>"street"</js>,<js>"city"</js>,<js>"state"</js>}) + <jk>public class</jk> Address { + ... + </p> + </dd> + </dl></div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="sort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sort</h4> +<pre>public abstract boolean <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.82">sort</a></pre> +<div class="block">Sort bean properties in alphabetical order. + <p> + When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order. + Otherwise, the natural order of the bean properties is used which is dependent on the + JVM vendor. + On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. + On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs). + <p> + This property is disabled by default so that IBM JVM users don't have to use <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations + to force bean properties to be in a particular order and can just alter the order of the fields/methods + in the Java file. + <p> + This annotation is equivalent to using the <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_sortProperties"><code>BeanContext.BEAN_sortProperties</code></a> property, but + applied to individual classes instead of globally at the serializer or parser level.</div> +<dl> +<dt>Default:</dt> +<dd>false</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="excludeProperties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>excludeProperties</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/Bean.html#line.102">excludeProperties</a></pre> +<div class="block">Specifies a list of properties that should be excluded from <a href="../../../../org/apache/juneau/BeanMap.html#entrySet--"><code>BeanMap.entrySet()</code></a>. + <p> + This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanTransform.html" title="class in org.apache.juneau.transform"><code>BeanTransform</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanTransform.html#getExcludeProperties--"><code>BeanTransform.getExcludeProperties()</code></a> method. + + <dl> + <dt>Example:</dt> + <dd> + <p class='bcode'> + <jc>// Address class with only street/city/state properties (in that order).</jc> + <jc>// All other properties are ignored.</jc> + <ja>@Bean</ja>(excludeProperties={<js>"city"</js>,<js>"state"</js>}) + <jk>public class</jk> Address { + ... + </p> + </dd> + </dl></div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="propertyNamer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>propertyNamer</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><? extends <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.126">propertyNamer</a></pre> +<div class="block">Associates a <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau"><code>PropertyNamer</code></a> with this bean to tailor the names of the bean properties. + <p> + Property namers are used to transform bean property names from standard form to some other form. + For example, the <a href="../../../../org/apache/juneau/PropertyNamerDashedLC.html" title="class in org.apache.juneau"><code>PropertyNamerDashedLC</code></a> will convert property names to dashed-lowercase, and + these will be used as attribute names in JSON, and element names in XML. + <p> + This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanTransform.html" title="class in org.apache.juneau.transform"><code>BeanTransform</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanTransform.html#getPropertyNamer--"><code>BeanTransform.getPropertyNamer()</code></a> method. + + <dl> + <dt>Example:</dt> + <dd> + <p class='bcode'> + <jc>// Define a class with dashed-lowercase property names.</jc> + <ja>@Bean</ja>(propertyNamer=PropertyNamerDashedLC.<jk>class</jk>) + <jk>public class</jk> MyClass { + ... + } + </p> + </dd> + </dl></div> +<dl> +<dt>Default:</dt> +<dd>org.apache.juneau.PropertyNamerDefault.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="subTypeProperty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subTypeProperty</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/Bean.html#line.175">subTypeProperty</a></pre> +<div class="block">Defines a virtual property on a superclass that identifies bean subtype classes. + <p> + In the following example, the abstract class has two subclasses that are differentiated + by a property called <code>subType</code> + <p class='bcode'> + <jc>// Abstract superclass</jc> + <ja>@Bean</ja>( + subTypeProperty=<js>"subType"</js>, + subTypes={ + <ja>@BeanSubType</ja>(type=A1.<jk>class</jk>, id=<js>"A1"</js>), + <ja>@BeanSubType</ja>(type=A2.<jk>class</jk>, id=<js>"A2"</js>) + } + ) + <jk>public class</jk> A { + <jk>public</jk> String <jf>f0</jf> = <js>"f0"</js>; + } + + <jc>// Subclass 1</jc> + <jk>public class</jk> A1 <jk>extends</jk> A { + <jk>public</jk> String <jf>f1</jf>; + } + + <jc>// Subclass 2</jc> + <jk>public class</jk> A2 <jk>extends</jk> A { + <jk>public</jk> String <jf>f2</jf>; + } + <p> + The following shows what happens when serializing a subclassed object to JSON: + <p class='bcode'> + JsonSerializer s = JsonSerializer.<jsf>DEFAULT_LAX</jsf>; + A1 a1 = <jk>new</jk> A1(); + a1.<jf>f1</jf> = <js>"f1"</js>; + String r = s.serialize(a1); + <jsm>assertEquals</jsm>(<js>"{subType:'A1',f1:'f1',f0:'f0'}"</js>, r); + </p> + <p> + The following shows what happens when parsing back into the original object. + <p> + <p class='bcode'> + JsonParser p = JsonParser.<jsf>DEFAULT</jsf>; + A a = p.parse(r, A.<jk>class</jk>); + <jsm>assertTrue</jsm>(a <jk>instanceof</jk> A1); + </p> + <p> + This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanTransform.html" title="class in org.apache.juneau.transform"><code>BeanTransform</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanTransform.html#getSubTypeProperty--"><code>BeanTransform.getSubTypeProperty()</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="subTypes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subTypes</h4> +<pre>public abstract <a href="../../../../org/apache/juneau/annotation/BeanSubType.html" title="annotation in org.apache.juneau.annotation">BeanSubType</a>[] <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.180">subTypes</a></pre> +<div class="block">Used in conjunction with <a href="../../../../org/apache/juneau/annotation/Bean.html#subTypeProperty--"><code>subTypeProperty()</code></a> to set up bean subtypes.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="interfaceClass--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>interfaceClass</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/Bean.html#line.210">interfaceClass</a></pre> +<div class="block">Identifies a class to be used as the interface class for this and all subclasses. + <p> + When specified, only the list of properties defined on the interface class will be used during serialization. + Additional properties on subclasses will be ignored. + <p class='bcode'> + <jc>// Parent class</jc> + <ja>@Bean</ja>(interfaceClass=A.<jk>class</jk>) + <jk>public abstract class</jk> A { + <jk>public</jk> String <jf>f0</jf> = <js>"f0"</js>; + } + + <jc>// Sub class</jc> + <jk>public class</jk> A1 <jk>extends</jk> A { + <jk>public</jk> String <jf>f1</jf> = <js>"f1"</js>; + } + + JsonSerializer s = JsonSerializer.<jsf>DEFAULT_LAX</jsf>; + A1 a1 = <jk>new</jk> A1(); + String r = s.serialize(a1); + <jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, r); // Note f1 is not serialized. + </p> + <p> + Note that this annotation can be used on the parent class so that it filters to all child classes, + or can be set individually on the child classes. + <p> + This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanTransform.html" title="class in org.apache.juneau.transform"><code>BeanTransform</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanTransform.html#getInterfaceClass--"><code>BeanTransform.getInterfaceClass()</code></a> method.</div> +<dl> +<dt>Default:</dt> +<dd>java.lang.Object.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="stopClass--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stopClass</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/Bean.html#line.235">stopClass</a></pre> +<div class="block">Identifies a stop class for the annotated class. + <p> + Identical in purpose to the stop class specified by <a href="http://docs.oracle.com/javase/7/docs/api/java/beans/Introspector.html?is-external=true#getBeanInfo-java.lang.Class-java.lang.Class-"; title="class or interface in java.beans"><code>Introspector.getBeanInfo(Class, Class)</code></a>. + Any properties in the stop class or in its baseclasses will be ignored during analysis. + <p> + For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>, but + not <code>p1</code> or <code>p2</code>. + <p class='bcode'> + <jk>public class</jk> C1 { + <jk>public int</jk> getP1(); + } + + <jk>public class</jk> C2 <jk>extends</jk> C1 { + <jk>public int</jk> getP2(); + } + + <ja>@Bean</ja>(stopClass=C2.<jk>class</jk>) + <jk>public class</jk> C3 <jk>extends</jk> C2 { + <jk>public int</jk> getP3(); + } + </p></div> +<dl> +<dt>Default:</dt> +<dd>java.lang.Object.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/Bean.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>Prev Class</li> +<li><a href="../../../../org/apache/juneau/annotation/BeanConstructor.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/Bean.html" target="_top">Frames</a></li> +<li><a href="Bean.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/annotation/BeanConstructor.html ---------------------------------------------------------------------- diff --git a/content/api-documentation/org/apache/juneau/annotation/BeanConstructor.html b/content/api-documentation/org/apache/juneau/annotation/BeanConstructor.html new file mode 100644 index 0000000..ac747d1 --- /dev/null +++ b/content/api-documentation/org/apache/juneau/annotation/BeanConstructor.html @@ -0,0 +1,275 @@ +<!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 --> +<title>BeanConstructor (Juneau)</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 (Juneau)"; + } + } + 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 ([email protected])</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 ======= --> +</body> +</html>
