Added: incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/AbstractConfigurable.html URL: http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/AbstractConfigurable.html?rev=1730211&view=auto ============================================================================== --- incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/AbstractConfigurable.html (added) +++ incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/AbstractConfigurable.html Sat Feb 13 14:08:40 2016 @@ -0,0 +1,567 @@ +<!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 (1.8.0_72-internal) on Sat Feb 13 14:02:40 GMT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractConfigurable (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-02-13"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.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="AbstractConfigurable (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; +var tabs = {65535:["t0","All 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/AbstractConfigurable.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/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/AbstractConfigurable.html" target="_top">Frames</a></li> +<li><a href="AbstractConfigurable.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.taverna.configuration</div> +<h2 title="Class AbstractConfigurable" class="title">Class AbstractConfigurable</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>org.apache.taverna.configuration.AbstractConfigurable</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/taverna/configuration/proxy/impl/HttpProxyConfigurationImpl.html" title="class in org.apache.taverna.configuration.proxy.impl">HttpProxyConfigurationImpl</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">AbstractConfigurable</span> +extends <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> +implements <a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></pre> +<div class="block">A utility abstract class that simplifies implementing a Configurable. + <br> + <p>A concrete version of this class needs to define the name,category, + UUID string and the set of default values.</p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Stuart Owen</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="memberSummary" 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://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/taverna/configuration/AbstractConfigurable.html#DELETED_VALUE_CODE">DELETED_VALUE_CODE</a></span></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#AbstractConfigurable-org.apache.taverna.configuration.ConfigurationManager-">AbstractConfigurable</a></span>(<a href="../../../../org/apache/taverna/configuration/ConfigurationManager.html" title="interface in org.apache.taverna.configuration">ConfigurationManager</a> configurationManager)</code> +<div class="block">Constructs the AbstractConfigurable by either reading from a previously stored set of properties, + or by using the default values which results in them being stored for subsequent usage.</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="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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#clear--">clear</a></span>()</code> </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/taverna/configuration/AbstractConfigurable.html#deleteProperty-java.lang.String-">deleteProperty</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> key)</code> +<div class="block">Deletes a property value for a given key.</div> +</td> +</tr> +<tr id="i2" 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/taverna/configuration/AbstractConfigurable.html#getDefaultProperty-java.lang.String-">getDefaultProperty</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> key)</code> +<div class="block">Provides the default property for a given key</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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/taverna/configuration/AbstractConfigurable.html#getInternalPropertyMap--">getInternalPropertyMap</a></span>()</code> +<div class="block">Provides access to the internal map.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#getKeys--">getKeys</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#getProperty-java.lang.String-">getProperty</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> key)</code> +<div class="block">Looks up the property for the given key.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#getPropertyStringList-java.lang.String-">getPropertyStringList</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> key)</code> +<div class="block">Returns an unmodifiable List<String> for the given key.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#restoreDefaults--">restoreDefaults</a></span>()</code> +<div class="block">Restore the default property map</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#setProperty-java.lang.String-java.lang.String-">setProperty</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> key, + <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> value)</code> +<div class="block">Overwrites or applies a new value against the given key in the property map.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#setPropertyStringList-java.lang.String-java.util.List-">setPropertyStringList</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> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> value)</code> +<div class="block">Set a value that is known to be a list.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#store--">store</a></span>()</code> </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://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#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.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/Object.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/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#hashCode--"; title="class or interface in java.lang">hashCode</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#toString--"; title="class or interface in java.lang">toString</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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.taverna.configuration.Configurable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.taverna.configuration.<a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></h3> +<code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getCategory--">getCategory</a>, <a href="../../../../org/apache/taverna/configuration/Configurable.html#getDefaultPropertyMap--">getDefaultPropertyMap</a>, <a href="../../../../org/apache/taverna/configuration/Configurable.html#getDisplayName--">getDisplayName</a>, <a href="../../../../org/apache/taverna/configuration/Configurable.html#getFilePrefix--">getFilePrefix</a>, <a href="../../../../org/apache/taverna/configuration/Configurable.html#getUUID--">getUUID</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="DELETED_VALUE_CODE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DELETED_VALUE_CODE</h4> +<pre>public static final <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> DELETED_VALUE_CODE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.taverna.configuration.AbstractConfigurable.DELETED_VALUE_CODE">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="AbstractConfigurable-org.apache.taverna.configuration.ConfigurationManager-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractConfigurable</h4> +<pre>public AbstractConfigurable(<a href="../../../../org/apache/taverna/configuration/ConfigurationManager.html" title="interface in org.apache.taverna.configuration">ConfigurationManager</a> configurationManager)</pre> +<div class="block">Constructs the AbstractConfigurable by either reading from a previously stored set of properties, + or by using the default values which results in them being stored for subsequent usage.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getKeys--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeys</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> getKeys()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getKeys--">getKeys</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +</dl> +</li> +</ul> +<a name="getProperty-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperty</h4> +<pre>public <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> getProperty(<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> key)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getProperty-java.lang.String-">Configurable</a></code></span></div> +<div class="block">Looks up the property for the given key. + <br> + Using this method is preferable to using the property map directly.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getProperty-java.lang.String-">getProperty</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the String represented by the key, the default value, or null</dd> +</dl> +</li> +</ul> +<a name="getDefaultProperty-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultProperty</h4> +<pre>public <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> getDefaultProperty(<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> key)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getDefaultProperty-java.lang.String-">Configurable</a></code></span></div> +<div class="block">Provides the default property for a given key</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getDefaultProperty-java.lang.String-">getDefaultProperty</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +</dl> +</li> +</ul> +<a name="store--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>store</h4> +<pre>protected void store()</pre> +</li> +</ul> +<a name="clear--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#clear--">clear</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +</dl> +</li> +</ul> +<a name="setProperty-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>public void setProperty(<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> key, + <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> value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/taverna/configuration/Configurable.html#setProperty-java.lang.String-java.lang.String-">Configurable</a></code></span></div> +<div class="block">Overwrites or applies a new value against the given key in the property map. + <br> + Setting a value to null is equivalent to calling this<a href="../../../../org/apache/taverna/configuration/Configurable.html#deleteProperty-java.lang.String-"><code>Configurable.deleteProperty(String)</code></a> + <br> + If the value is new, or changed, the the property map is stored. + <br> + Using this method is preferable to using the property map directly.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#setProperty-java.lang.String-java.lang.String-">setProperty</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +</dl> +</li> +</ul> +<a name="getInternalPropertyMap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalPropertyMap</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>> getInternalPropertyMap()</pre> +<div class="block">Provides access to the internal map. + <br> + Note that this map will contain entries for deleted values that also have corresponding default values. + For this reason using this map directly is discouraged, and #getProperty(String)} should be used instead.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getInternalPropertyMap--">getInternalPropertyMap</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +</dl> +</li> +</ul> +<a name="restoreDefaults--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restoreDefaults</h4> +<pre>public void restoreDefaults()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/taverna/configuration/Configurable.html#restoreDefaults--">Configurable</a></code></span></div> +<div class="block">Restore the default property map</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#restoreDefaults--">restoreDefaults</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +</dl> +</li> +</ul> +<a name="deleteProperty-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteProperty</h4> +<pre>public void deleteProperty(<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> key)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/taverna/configuration/Configurable.html#deleteProperty-java.lang.String-">Configurable</a></code></span></div> +<div class="block">Deletes a property value for a given key. + <br> + Subsequent calls to this<a href="../../../../org/apache/taverna/configuration/Configurable.html#getProperty-java.lang.String-"><code>Configurable.getProperty(String)</code></a> will return null.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#deleteProperty-java.lang.String-">deleteProperty</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyStringList-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyStringList</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> getPropertyStringList(<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> key)</pre> +<div class="block">Returns an unmodifiable List<String> for the given key. Internally the value is stored as a single String, but converted to a list when calling this method. + <br> + The list is unmodifiable to prevent the mistake of trying <pre>getPropertyStringList(..).add("new element");</pre> which will not affect the stored + list. For the property to be updated this<a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#setPropertyStringList-java.lang.String-java.util.List-"><code>setPropertyStringList(String, List)</code></a> must be used.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#getPropertyStringList-java.lang.String-">getPropertyStringList</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></dd> +</dl> +</li> +</ul> +<a name="setPropertyStringList-java.lang.String-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setPropertyStringList</h4> +<pre>public void setPropertyStringList(<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> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> value)</pre> +<div class="block">Set a value that is known to be a list. The value can be retrieved using this<a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html#getPropertyStringList-java.lang.String-"><code>getPropertyStringList(String)</code></a> + <br> + Within the file, the value is stored as a single Comma Separated Value</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/taverna/configuration/Configurable.html#setPropertyStringList-java.lang.String-java.util.List-">setPropertyStringList</a></code> in interface <code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</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> +<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/AbstractConfigurable.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/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/AbstractConfigurable.html" target="_top">Frames</a></li> +<li><a href="AbstractConfigurable.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 © 2015–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/Configurable.html URL: http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/Configurable.html?rev=1730211&view=auto ============================================================================== --- incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/Configurable.html (added) +++ incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/Configurable.html Sat Feb 13 14:08:40 2016 @@ -0,0 +1,496 @@ +<!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 (1.8.0_72-internal) on Sat Feb 13 14:02:40 GMT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Configurable (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-02-13"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.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="Configurable (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":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/Configurable.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/taverna/configuration/AbstractConfigurable.html" title="class in org.apache.taverna.configuration"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/taverna/configuration/ConfigurationManager.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/Configurable.html" target="_top">Frames</a></li> +<li><a href="Configurable.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.taverna.configuration</div> +<h2 title="Interface Configurable" class="title">Interface Configurable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/taverna/configuration/proxy/HttpProxyConfiguration.html" title="interface in org.apache.taverna.configuration.proxy">HttpProxyConfiguration</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/taverna/configuration/AbstractConfigurable.html" title="class in org.apache.taverna.configuration">AbstractConfigurable</a>, <a href="../../../../org/apache/taverna/configuration/proxy/impl/HttpProxyConfigurationImpl.html" title="class in org.apache.taverna.configuration.proxy.impl">HttpProxyConfigurationImpl</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Configurable</span></pre> +<div class="block">An interface that defines an Object as being configurable. + It supports the core properties that allows this items configuration to be stored and re-populated by the ConfigurationManager</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Stuart Owen</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#clear--">clear</a></span>()</code> </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/taverna/configuration/Configurable.html#deleteProperty-java.lang.String-">deleteProperty</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> key)</code> +<div class="block">Deletes a property value for a given key.</div> +</td> +</tr> +<tr id="i2" 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/taverna/configuration/Configurable.html#getCategory--">getCategory</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#getDefaultProperty-java.lang.String-">getDefaultProperty</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> key)</code> +<div class="block">Provides the default property for a given key</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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/taverna/configuration/Configurable.html#getDefaultPropertyMap--">getDefaultPropertyMap</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#getDisplayName--">getDisplayName</a></span>()</code> </td> +</tr> +<tr id="i6" 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/taverna/configuration/Configurable.html#getFilePrefix--">getFilePrefix</a></span>()</code> +<div class="block">return a file-system suitable prefix</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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/taverna/configuration/Configurable.html#getInternalPropertyMap--">getInternalPropertyMap</a></span>()</code> +<div class="block">Provides access to the internal map.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#getKeys--">getKeys</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#getProperty-java.lang.String-">getProperty</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> key)</code> +<div class="block">Looks up the property for the given key.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#getPropertyStringList-java.lang.String-">getPropertyStringList</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> key)</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#getUUID--">getUUID</a></span>()</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#restoreDefaults--">restoreDefaults</a></span>()</code> +<div class="block">Restore the default property map</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#setProperty-java.lang.String-java.lang.String-">setProperty</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> key, + <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> value)</code> +<div class="block">Overwrites or applies a new value against the given key in the property map.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/Configurable.html#setPropertyStringList-java.lang.String-java.util.List-">setPropertyStringList</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> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> value)</code> </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="getDefaultPropertyMap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultPropertyMap</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>> getDefaultPropertyMap()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a Map containing the default value/key pairs of the configured properties</dd> +</dl> +</li> +</ul> +<a name="getUUID--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUUID</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> getUUID()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a globally unique identifier that ensures that when stored this items configuration details will never clash with another</dd> +</dl> +</li> +</ul> +<a name="getDisplayName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDisplayName</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> getDisplayName()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a friendly name for the item</dd> +</dl> +</li> +</ul> +<a name="getFilePrefix--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilePrefix</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> getFilePrefix()</pre> +<div class="block">return a file-system suitable prefix</div> +</li> +</ul> +<a name="getCategory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCategory</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> getCategory()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a String defining the category of configurations that this item belongs to.</dd> +</dl> +</li> +</ul> +<a name="restoreDefaults--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restoreDefaults</h4> +<pre>void restoreDefaults()</pre> +<div class="block">Restore the default property map</div> +</li> +</ul> +<a name="getDefaultProperty-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultProperty</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> getDefaultProperty(<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> key)</pre> +<div class="block">Provides the default property for a given key</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +</dl> +</li> +</ul> +<a name="getKeys--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeys</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> getKeys()</pre> +</li> +</ul> +<a name="clear--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>void clear()</pre> +</li> +</ul> +<a name="getInternalPropertyMap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalPropertyMap</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>> getInternalPropertyMap()</pre> +<div class="block">Provides access to the internal map. + <br> + Note that this map may contain internal identifiers for deleted entries for deleted values that also have corresponding default values. + For this reason using this map directly is discouraged, and #getProperty(String)} should be used instead.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +</dl> +</li> +</ul> +<a name="getProperty-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperty</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> getProperty(<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> key)</pre> +<div class="block">Looks up the property for the given key. + <br> + Using this method is preferable to using the property map directly.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the String represented by the key, the default value, or null</dd> +</dl> +</li> +</ul> +<a name="setProperty-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>void setProperty(<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> key, + <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> value)</pre> +<div class="block">Overwrites or applies a new value against the given key in the property map. + <br> + Setting a value to null is equivalent to calling this<a href="../../../../org/apache/taverna/configuration/Configurable.html#deleteProperty-java.lang.String-"><code>deleteProperty(String)</code></a> + <br> + If the value is new, or changed, the the property map is stored. + <br> + Using this method is preferable to using the property map directly.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - </dd> +<dd><code>value</code> - </dd> +</dl> +</li> +</ul> +<a name="deleteProperty-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteProperty</h4> +<pre>void deleteProperty(<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> key)</pre> +<div class="block">Deletes a property value for a given key. + <br> + Subsequent calls to this<a href="../../../../org/apache/taverna/configuration/Configurable.html#getProperty-java.lang.String-"><code>getProperty(String)</code></a> will return null.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - </dd> +</dl> +</li> +</ul> +<a name="getPropertyStringList-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyStringList</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> getPropertyStringList(<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> key)</pre> +</li> +</ul> +<a name="setPropertyStringList-java.lang.String-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setPropertyStringList</h4> +<pre>void setPropertyStringList(<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> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</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>> value)</pre> +</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/Configurable.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/taverna/configuration/AbstractConfigurable.html" title="class in org.apache.taverna.configuration"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/taverna/configuration/ConfigurationManager.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/Configurable.html" target="_top">Frames</a></li> +<li><a href="Configurable.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 ======= --> +<p class="legalCopy"><small>Copyright © 2015–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationManager.html URL: http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationManager.html?rev=1730211&view=auto ============================================================================== --- incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationManager.html (added) +++ incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationManager.html Sat Feb 13 14:08:40 2016 @@ -0,0 +1,271 @@ +<!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 (1.8.0_72-internal) on Sat Feb 13 14:02:40 GMT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConfigurationManager (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-02-13"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.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="ConfigurationManager (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)"; + } + } + 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/ConfigurationManager.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/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/taverna/configuration/ConfigurationUIFactory.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/ConfigurationManager.html" target="_top">Frames</a></li> +<li><a href="ConfigurationManager.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.taverna.configuration</div> +<h2 title="Interface ConfigurationManager" class="title">Interface ConfigurationManager</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/taverna/configuration/impl/ConfigurationManagerImpl.html" title="class in org.apache.taverna.configuration.impl">ConfigurationManagerImpl</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ConfigurationManager</span></pre> +<div class="block">Handles the configuration for a <a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><code>Configurable</code></a> object</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>David Withers</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/ConfigurationManager.html#populate-org.apache.taverna.configuration.Configurable-">populate</a></span>(<a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a> configurable)</code> +<div class="block">Loads the configuration details from disk or from memory and populates the provided Configurable</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/taverna/configuration/ConfigurationManager.html#store-org.apache.taverna.configuration.Configurable-">store</a></span>(<a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a> configurable)</code> +<div class="block">Write out the properties configuration to disk based on the UUID of the + <a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><code>Configurable</code></a> + <br> + Default values are not stored within the file, but only those that have been changed or deleted.</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="store-org.apache.taverna.configuration.Configurable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>store</h4> +<pre>void store(<a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a> configurable) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Write out the properties configuration to disk based on the UUID of the + <a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><code>Configurable</code></a> + <br> + Default values are not stored within the file, but only those that have been changed or deleted.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>configurable</code> - </dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="populate-org.apache.taverna.configuration.Configurable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>populate</h4> +<pre>void populate(<a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a> configurable) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Loads the configuration details from disk or from memory and populates the provided Configurable</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>configurable</code> - </dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - if there are no configuration details available</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/ConfigurationManager.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/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/taverna/configuration/ConfigurationUIFactory.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/ConfigurationManager.html" target="_top">Frames</a></li> +<li><a href="ConfigurationManager.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 ======= --> +<p class="legalCopy"><small>Copyright © 2015–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationUIFactory.html URL: http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationUIFactory.html?rev=1730211&view=auto ============================================================================== --- incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationUIFactory.html (added) +++ incubator/taverna/site/trunk/content/javadoc/taverna-osgi/org/apache/taverna/configuration/ConfigurationUIFactory.html Sat Feb 13 14:08:40 2016 @@ -0,0 +1,249 @@ +<!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 (1.8.0_72-internal) on Sat Feb 13 14:02:40 GMT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConfigurationUIFactory (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-02-13"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.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="ConfigurationUIFactory (Apache Taverna OSGi plugin system 0.2.1-incubating-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":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/ConfigurationUIFactory.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/taverna/configuration/ConfigurationManager.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/ConfigurationUIFactory.html" target="_top">Frames</a></li> +<li><a href="ConfigurationUIFactory.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.taverna.configuration</div> +<h2 title="Interface ConfigurationUIFactory" class="title">Interface ConfigurationUIFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ConfigurationUIFactory</span></pre> +</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/ConfigurationUIFactory.html#canHandle-java.lang.String-">canHandle</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> uuid)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/ConfigurationUIFactory.html#getConfigurable--">getConfigurable</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/swing/JPanel.html?is-external=true"; title="class or interface in javax.swing">JPanel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/taverna/configuration/ConfigurationUIFactory.html#getConfigurationPanel--">getConfigurationPanel</a></span>()</code> </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="canHandle-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canHandle</h4> +<pre>boolean canHandle(<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> uuid)</pre> +</li> +</ul> +<a name="getConfigurationPanel--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigurationPanel</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/swing/JPanel.html?is-external=true"; title="class or interface in javax.swing">JPanel</a> getConfigurationPanel()</pre> +</li> +</ul> +<a name="getConfigurable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConfigurable</h4> +<pre><a href="../../../../org/apache/taverna/configuration/Configurable.html" title="interface in org.apache.taverna.configuration">Configurable</a> getConfigurable()</pre> +</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/ConfigurationUIFactory.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/taverna/configuration/ConfigurationManager.html" title="interface in org.apache.taverna.configuration"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/taverna/configuration/ConfigurationUIFactory.html" target="_top">Frames</a></li> +<li><a href="ConfigurationUIFactory.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 ======= --> +<p class="legalCopy"><small>Copyright © 2015–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
