| <!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 (version 1.7.0_121) on Fri Jan 06 19:36:23 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Value (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Value (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| 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><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Value.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/openjpa/lib/conf/StringValue.html" title="class in org.apache.openjpa.lib.conf"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/conf/Value.html" target="_top">Frames</a></li> |
| <li><a href="Value.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="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.openjpa.lib.conf</div> |
| <h2 title="Class Value" class="title">Class Value</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/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>org.apache.openjpa.lib.conf.Value</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/lib/conf/BooleanValue.html" title="class in org.apache.openjpa.lib.conf">BooleanValue</a>, <a href="../../../../../org/apache/openjpa/lib/conf/DoubleValue.html" title="class in org.apache.openjpa.lib.conf">DoubleValue</a>, <a href="../../../../../org/apache/openjpa/lib/conf/FileValue.html" title="class in org.apache.openjpa.lib.conf">FileValue</a>, <a href="../../../../../org/apache/openjpa/lib/conf/IntValue.html" title="class in org.apache.openjpa.lib.conf">IntValue</a>, <a href="../../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</a>, <a href="../../../../../org/apache/openjpa/lib/conf/StringListValue.html" title="class in org.apache.openjpa.lib.conf">StringListValue</a>, <a href="../../../../../org/apache/openjpa/lib/conf/StringValue.html" title="class in org.apache.openjpa.lib.conf">StringValue</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">Value</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre> |
| <div class="block">A configuration value.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Marc Prud'hommeaux, Pinaki Poddar</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#INVISIBLE">INVISIBLE</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#Value()">Value</a></strong>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#Value(java.lang.String)">Value</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prop)</code> |
| <div class="block">Constructor.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#addEquivalentKey(java.lang.String)">addEquivalentKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> other)</code> |
| <div class="block">Adds a moniker that is equivalent to the original property key used |
| during construction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#addListener(org.apache.openjpa.lib.conf.ValueListener)">addListener</a></strong>(<a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a> listener)</code> |
| <div class="block">Listener for value changes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#alias(java.lang.String)">alias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Alias the given setting.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#alias(java.lang.String,%20java.lang.String[],%20boolean)">alias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases, |
| boolean nullNotFound)</code> |
| <div class="block">Alias the given setting.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#assertChangeable()">assertChangeable</a></strong>()</code> |
| <div class="block">Asserts if this receiver can be changed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#clone()">clone</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> |
| <div class="block">Use <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getOriginalValue()"><code>original value</code></a> instead of |
| <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getString()"><code>current value</code></a> because they are one and the same |
| for non-dynamic Values and ensures that modifying dynamic Values do not |
| impact equality or hashCode contract.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#get()">get</a></strong>()</code> |
| <div class="block">Get the actual data stored in this value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getAliases()">getAliases</a></strong>()</code> |
| <div class="block">Aliases for the value in the form key1, value1, key2, value2, ...</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getDefault()">getDefault</a></strong>()</code> |
| <div class="block">The default value for the property as a string.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getEquivalentKeys()">getEquivalentKeys</a></strong>()</code> |
| <div class="block">Gets the unmodifiable view of the equivalent keys or an empty set if |
| no equivalent key has been added.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getInstantiatingGetter()">getInstantiatingGetter</a></strong>()</code> |
| <div class="block">The name of the getter method for the instantiated value of this |
| property(as opposed to the string value)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getInternalString()">getInternalString</a></strong>()</code> |
| <div class="block">Return the internal string form of this value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getListeners()">getListeners</a></strong>()</code> |
| <div class="block">Gets unmodifable list of listeners for value changes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getLoadKey()">getLoadKey</a></strong>()</code> |
| <div class="block">The key under which this value was loaded, or null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getOriginalValue()">getOriginalValue</a></strong>()</code> |
| <div class="block">Gets the original value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getProperty()">getProperty</a></strong>()</code> |
| <div class="block">The property name that will be used when setting or |
| getting this value in a <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getPropertyKeys()">getPropertyKeys</a></strong>()</code> |
| <div class="block">Gets unmodifiable view of all the property keys set on this receiver.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getScope()">getScope</a></strong>()</code> |
| <div class="block">A class defining the scope in which this value is defined.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getString()">getString</a></strong>()</code> |
| <div class="block">Return a stringified version of this value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getValueType()">getValueType</a></strong>()</code> |
| <div class="block">Returns the type of the property that this Value represents.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#hashCode()">hashCode</a></strong>()</code> |
| <div class="block">Use <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getOriginalValue()"><code>original value</code></a> instead of |
| <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getString()"><code>current value</code></a> because they are one and the same |
| for non-dynamic Values and ensures that modifying dynamic Values do not |
| impact equality or hashCode contract.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#hide()">hide</a></strong>()</code> |
| <div class="block">Hides the value of this Value from being output to the caller.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#isAliasListComprehensive()">isAliasListComprehensive</a></strong>()</code> |
| <div class="block">Whether or not the alias list defines all possible settings for this |
| value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#isDynamic()">isDynamic</a></strong>()</code> |
| <div class="block">Affirms if this receiver can be mutated even when the configuration it |
| belongs to has been <a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html#isReadOnly()"><code>frozen</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#isHidden()">isHidden</a></strong>()</code> |
| <div class="block">Affirms if the value for this Value is visible.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#isPrivate()">isPrivate</a></strong>()</code> |
| <div class="block">Affirms if this Value is used for internal purpose only and not exposed as a supported property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#makePrivate()">makePrivate</a></strong>()</code> |
| <div class="block">Marks this Value for internal purpose only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#matches(java.lang.String)">matches</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> p)</code> |
| <div class="block">Affirms if the given key matches the property (or any of its equivalent).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#removeListener(org.apache.openjpa.lib.conf.ValueListener)">removeListener</a></strong>(<a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a> listener)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setAlias(java.lang.String,%20java.lang.String)">setAlias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> |
| <div class="block">Replaces an existing alias, or adds the given alias to the front of the |
| alias list if it does not already exist.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setAlias(java.lang.String,%20java.lang.String,%20java.lang.String[])">setAlias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases)</code> |
| <div class="block">Set an alias into a current alias list, returning the new list.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setAliases(java.lang.String[])">setAliases</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases)</code> |
| <div class="block">Aliases for the value in the form key1, value1, key2, value2, ...</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setAliasListComprehensive(boolean)">setAliasListComprehensive</a></strong>(boolean aliasListIsComprehensive)</code> |
| <div class="block">Whether or not the alias list defines all possible settings for this |
| value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setDefault(java.lang.String)">setDefault</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> def)</code> |
| <div class="block">The default value for the property as a string.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setDynamic(boolean)">setDynamic</a></strong>(boolean flag)</code> |
| <div class="block">Sets if this receiver can be mutated even when the configuration it |
| belongs to has been <a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html#isReadOnly()"><code>frozen</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setInstantiatingGetter(java.lang.String)">setInstantiatingGetter</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getter)</code> |
| <div class="block">The name of the getter method for the instantiated value of this |
| property(as opposed to the string value).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setInternalObject(java.lang.Object)">setInternalObject</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">Set this value from an object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setInternalString(java.lang.String)">setInternalString</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Set this value from the given string.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setLoadKey(java.lang.String)">setLoadKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Sets key under which this value was loaded.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setObject(java.lang.Object)">setObject</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">Set this value as an object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setProperty(java.lang.String)">setProperty</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prop)</code> |
| <div class="block">The property name that will be used when setting or |
| getting this value in a <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setScope(java.lang.Class)">setScope</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls)</code> |
| <div class="block">A class defining the scope in which this value is defined.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setString(java.lang.String)">setString</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> val)</code> |
| <div class="block">Set this value from the given string.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#toString()">toString</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#unalias(java.lang.String)">unalias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Unalias the given setting.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#unalias(java.lang.String,%20java.lang.String[],%20boolean)">unalias</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases, |
| boolean nullNotFound)</code> |
| <div class="block">Unalias the given setting.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#valueChanged()">valueChanged</a></strong>()</code> |
| <div class="block">Subclasses should call this method when their internal value changes.</div> |
| </td> |
| </tr> |
| </table> |
| <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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="INVISIBLE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>INVISIBLE</h4> |
| <pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> INVISIBLE</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.lib.conf.Value.INVISIBLE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Value()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Value</h4> |
| <pre>public Value()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| <a name="Value(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Value</h4> |
| <pre>public Value(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prop)</pre> |
| <div class="block">Constructor. Supply the property name.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/openjpa/lib/conf/Value.html#setProperty(java.lang.String)"><code>setProperty(java.lang.String)</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getProperty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getProperty()</pre> |
| <div class="block">The property name that will be used when setting or |
| getting this value in a <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public void setProperty(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prop)</pre> |
| <div class="block">The property name that will be used when setting or |
| getting this value in a <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>.</div> |
| </li> |
| </ul> |
| <a name="addEquivalentKey(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEquivalentKey</h4> |
| <pre>public void addEquivalentKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> other)</pre> |
| <div class="block">Adds a moniker that is equivalent to the original property key used |
| during construction.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getEquivalentKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEquivalentKeys</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getEquivalentKeys()</pre> |
| <div class="block">Gets the unmodifiable view of the equivalent keys or an empty set if |
| no equivalent key has been added.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getPropertyKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPropertyKeys</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getPropertyKeys()</pre> |
| <div class="block">Gets unmodifiable view of all the property keys set on this receiver. |
| The 0-th element in the returned list is always the same as the original |
| key returned by <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getProperty()"><code>getProperty()</code></a> method.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="matches(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matches</h4> |
| <pre>public boolean matches(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> p)</pre> |
| <div class="block">Affirms if the given key matches the property (or any of its equivalent).</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getLoadKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoadKey</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLoadKey()</pre> |
| <div class="block">The key under which this value was loaded, or null.</div> |
| </li> |
| </ul> |
| <a name="setLoadKey(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLoadKey</h4> |
| <pre>public void setLoadKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Sets key under which this value was loaded.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code>if</code> - called with a non-null key which is different from an |
| already loaded key.</dd></dl> |
| </li> |
| </ul> |
| <a name="getAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAliases</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getAliases()</pre> |
| <div class="block">Aliases for the value in the form key1, value1, key2, value2, ... |
| All alias values must be in string form.</div> |
| </li> |
| </ul> |
| <a name="setAliases(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAliases</h4> |
| <pre>public void setAliases(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases)</pre> |
| <div class="block">Aliases for the value in the form key1, value1, key2, value2, ... |
| All alias values must be in string form. |
| <p> |
| To avoid potential side-effects, this method copies the array passed in.</div> |
| </li> |
| </ul> |
| <a name="setAlias(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAlias</h4> |
| <pre>public void setAlias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> |
| <div class="block">Replaces an existing alias, or adds the given alias to the front of the |
| alias list if it does not already exist. All alias values must be in |
| string form.</div> |
| </li> |
| </ul> |
| <a name="setAlias(java.lang.String, java.lang.String, java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAlias</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] setAlias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases)</pre> |
| <div class="block">Set an alias into a current alias list, returning the new list.</div> |
| </li> |
| </ul> |
| <a name="isAliasListComprehensive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAliasListComprehensive</h4> |
| <pre>public boolean isAliasListComprehensive()</pre> |
| <div class="block">Whether or not the alias list defines all possible settings for this |
| value. If so, an error will be generated when attempting to invoke |
| any method on this value with an unknown option.</div> |
| </li> |
| </ul> |
| <a name="setAliasListComprehensive(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAliasListComprehensive</h4> |
| <pre>public void setAliasListComprehensive(boolean aliasListIsComprehensive)</pre> |
| <div class="block">Whether or not the alias list defines all possible settings for this |
| value. If so, an error will be generated when attempting to invoke |
| any method on this value with an unknown option.</div> |
| </li> |
| </ul> |
| <a name="alias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alias</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Alias the given setting.</div> |
| </li> |
| </ul> |
| <a name="alias(java.lang.String, java.lang.String[], boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alias</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases, |
| boolean nullNotFound)</pre> |
| <div class="block">Alias the given setting.</div> |
| </li> |
| </ul> |
| <a name="unalias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unalias</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> unalias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Unalias the given setting.</div> |
| </li> |
| </ul> |
| <a name="unalias(java.lang.String, java.lang.String[], boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unalias</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> unalias(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] aliases, |
| boolean nullNotFound)</pre> |
| <div class="block">Unalias the given setting.</div> |
| </li> |
| </ul> |
| <a name="getDefault()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefault</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefault()</pre> |
| <div class="block">The default value for the property as a string.</div> |
| </li> |
| </ul> |
| <a name="setDefault(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefault</h4> |
| <pre>public void setDefault(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> def)</pre> |
| <div class="block">The default value for the property as a string.</div> |
| </li> |
| </ul> |
| <a name="getInstantiatingGetter()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstantiatingGetter</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getInstantiatingGetter()</pre> |
| <div class="block">The name of the getter method for the instantiated value of this |
| property(as opposed to the string value)</div> |
| </li> |
| </ul> |
| <a name="setInstantiatingGetter(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInstantiatingGetter</h4> |
| <pre>public void setInstantiatingGetter(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getter)</pre> |
| <div class="block">The name of the getter method for the instantiated value of this |
| property(as opposed to the string value). If the string starts with |
| <code>this.</code>, then the getter will be looked up on the value |
| instance itself. Otherwise, the getter will be looked up on the |
| configuration instance.</div> |
| </li> |
| </ul> |
| <a name="getScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScope</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getScope()</pre> |
| <div class="block">A class defining the scope in which this value is defined. This will |
| be used by the configuration framework to look up metadata about |
| the value.</div> |
| </li> |
| </ul> |
| <a name="setScope(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScope</h4> |
| <pre>public void setScope(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls)</pre> |
| <div class="block">A class defining the scope in which this value is defined. This will |
| be used by the configuration framework to look up metadata about |
| the value.</div> |
| </li> |
| </ul> |
| <a name="getString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getString()</pre> |
| <div class="block">Return a stringified version of this value. If the current value has |
| a short alias key, the alias key is returned.</div> |
| </li> |
| </ul> |
| <a name="setString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setString</h4> |
| <pre>public void setString(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> val)</pre> |
| <div class="block">Set this value from the given string. If the given string is null or |
| empty and a default is defined, the default is used. If the given |
| string(or default) is an alias key, it will be converted to the |
| corresponding value internally. |
| <br> |
| If this Value is being set to a non-default value for the first time |
| (as designated by <code>originalString</code> being null), then the |
| value is remembered as <em>original</em>. This original value is used |
| for equality and hashCode computation if this Value is |
| <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#isDynamic()"><code>dynamic</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setObject(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObject</h4> |
| <pre>public void setObject(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> |
| <div class="block">Set this value as an object. |
| <br> |
| If this Value is being set to a non-default value for the first time |
| (as designated by <code>originalString</code> being null), then the |
| value is remembered as <em>original</em>. This original value is used |
| for equality and hashCode computation if this Value is |
| <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#isDynamic()"><code>dynamic</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getOriginalValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOriginalValue</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOriginalValue()</pre> |
| <div class="block">Gets the original value. Original value denotes the Stringified form of |
| this Value, from which it has been set, if ever. If this Value has never |
| been set to a non-default value, then returns the default value, which |
| itself can be null.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getValueType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getValueType()</pre> |
| <div class="block">Returns the type of the property that this Value represents.</div> |
| </li> |
| </ul> |
| <a name="getInternalString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInternalString</h4> |
| <pre>protected abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getInternalString()</pre> |
| <div class="block">Return the internal string form of this value.</div> |
| </li> |
| </ul> |
| <a name="setInternalString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInternalString</h4> |
| <pre>protected abstract void setInternalString(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Set this value from the given string.</div> |
| </li> |
| </ul> |
| <a name="setInternalObject(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInternalObject</h4> |
| <pre>protected abstract void setInternalObject(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> |
| <div class="block">Set this value from an object.</div> |
| </li> |
| </ul> |
| <a name="getListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListeners</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a>> getListeners()</pre> |
| <div class="block">Gets unmodifable list of listeners for value changes.</div> |
| </li> |
| </ul> |
| <a name="addListener(org.apache.openjpa.lib.conf.ValueListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addListener</h4> |
| <pre>public void addListener(<a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a> listener)</pre> |
| <div class="block">Listener for value changes.</div> |
| </li> |
| </ul> |
| <a name="removeListener(org.apache.openjpa.lib.conf.ValueListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeListener</h4> |
| <pre>public void removeListener(<a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a> listener)</pre> |
| </li> |
| </ul> |
| <a name="valueChanged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueChanged</h4> |
| <pre>public void valueChanged()</pre> |
| <div class="block">Subclasses should call this method when their internal value changes.</div> |
| </li> |
| </ul> |
| <a name="assertChangeable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertChangeable</h4> |
| <pre>protected void assertChangeable()</pre> |
| <div class="block">Asserts if this receiver can be changed. |
| Subclasses <em>must</em> invoke this method before changing its |
| internal state. |
| |
| This receiver can not be changed if all of the following is true |
| <LI>this receiver is not dynamic |
| <LI>ValueListener attached to this receiver is a Configuration |
| <LI>Configuration is read-only</div> |
| </li> |
| </ul> |
| <a name="setDynamic(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDynamic</h4> |
| <pre>public void setDynamic(boolean flag)</pre> |
| <div class="block">Sets if this receiver can be mutated even when the configuration it |
| belongs to has been <a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html#isReadOnly()"><code>frozen</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="isDynamic()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDynamic</h4> |
| <pre>public boolean isDynamic()</pre> |
| <div class="block">Affirms if this receiver can be mutated even when the configuration it |
| belongs to has been <a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html#isReadOnly()"><code>frozen</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <div class="block">Use <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getOriginalValue()"><code>original value</code></a> instead of |
| <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getString()"><code>current value</code></a> because they are one and the same |
| for non-dynamic Values and ensures that modifying dynamic Values do not |
| impact equality or hashCode contract.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</pre> |
| <div class="block">Use <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getOriginalValue()"><code>original value</code></a> instead of |
| <a href="../../../../../org/apache/openjpa/lib/conf/Value.html#getString()"><code>current value</code></a> because they are one and the same |
| for non-dynamic Values and ensures that modifying dynamic Values do not |
| impact equality or hashCode contract.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clone()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHidden()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHidden</h4> |
| <pre>public boolean isHidden()</pre> |
| <div class="block">Affirms if the value for this Value is visible. |
| Certain sensitive value such as password can be made invisible |
| so that it is not returned to the user code.</div> |
| </li> |
| </ul> |
| <a name="hide()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hide</h4> |
| <pre>public void hide()</pre> |
| <div class="block">Hides the value of this Value from being output to the caller.</div> |
| </li> |
| </ul> |
| <a name="isPrivate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrivate</h4> |
| <pre>public boolean isPrivate()</pre> |
| <div class="block">Affirms if this Value is used for internal purpose only and not exposed as a supported property.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html#getPropertyKeys()"><code>Configuration.getPropertyKeys()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="makePrivate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makePrivate</h4> |
| <pre>public void makePrivate()</pre> |
| <div class="block">Marks this Value for internal purpose only.</div> |
| </li> |
| </ul> |
| <a name="get()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> get()</pre> |
| <div class="block">Get the actual data stored in this value.</div> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Value.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/openjpa/lib/conf/StringValue.html" title="class in org.apache.openjpa.lib.conf"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/conf/Value.html" target="_top">Frames</a></li> |
| <li><a href="Value.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="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |