blob: f95e5c84f0976169166fbf85d690c1e116f779af [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
<title>LongID.LongNamespace (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="dc.created" content="2021-06-15">
<meta name="description" content="declaration: package: org.eclipse.ecf.core.identity, class: LongID, class: LongNamespace">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":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";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LongID.LongNamespace.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.core.identity</a></div>
<h1 title="Class LongID.LongNamespace" class="title">Class LongID.LongNamespace</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a>
<div class="inheritance"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">org.eclipse.ecf.core.identity.Namespace</a>
<div class="inheritance">org.eclipse.ecf.core.identity.LongID.LongNamespace</div>
</div>
</div>
<section class="description">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code>org.eclipse.core.runtime.IAdaptable</code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="LongID.html" title="class in org.eclipse.ecf.core.identity">LongID</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">LongID.LongNamespace</span>
extends <a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.ecf.core.identity.LongID.LongNamespace">Serialized Form</a></dd>
</dl>
</section>
<section class="summary">
<ul class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<li class="blockList">
<section class="fieldSummary"><a id="field.summary">
<!-- -->
</a>
<h2>Field Summary</h2>
<div class="inheritedList">
<h3>Fields inherited from class&nbsp;org.eclipse.ecf.core.identity.<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></h3>
<a id="fields.inherited.from.class.org.eclipse.ecf.core.identity.Namespace">
<!-- -->
</a><code><a href="Namespace.html#SCHEME_SEPARATOR">SCHEME_SEPARATOR</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">LongNamespace</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createInstance(java.lang.Object%5B%5D)">createInstance</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;args)</code></th>
<td class="colLast">
<div class="block">Make an instance of this namespace.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheme()">getScheme</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the primary scheme associated with this namespace.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;[][]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSupportedParameterTypes()">getSupportedParameterTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the supported parameter types for IDs created via subsequent calls to
<a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;org.eclipse.ecf.core.identity.<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></h3>
<a id="methods.inherited.from.class.org.eclipse.ecf.core.identity.Namespace">
<!-- -->
</a><code><a href="Namespace.html#equals(java.lang.Object)">equals</a>, <a href="Namespace.html#getAdapter(java.lang.Class)">getAdapter</a>, <a href="Namespace.html#getCompareToForObject(org.eclipse.ecf.core.identity.BaseID,org.eclipse.ecf.core.identity.BaseID)">getCompareToForObject</a>, <a href="Namespace.html#getDescription()">getDescription</a>, <a href="Namespace.html#getHashCodeForID(org.eclipse.ecf.core.identity.BaseID)">getHashCodeForID</a>, <a href="Namespace.html#getInitStringFromExternalForm(java.lang.Object%5B%5D)">getInitStringFromExternalForm</a>, <a href="Namespace.html#getName()">getName</a>, <a href="Namespace.html#getNameForID(org.eclipse.ecf.core.identity.BaseID)">getNameForID</a>, <a href="Namespace.html#getSupportedSchemes()">getSupportedSchemes</a>, <a href="Namespace.html#hashCode()">hashCode</a>, <a href="Namespace.html#initialize(java.lang.String,java.lang.String)">initialize</a>, <a href="Namespace.html#testIDEquals(org.eclipse.ecf.core.identity.BaseID,org.eclipse.ecf.core.identity.BaseID)">testIDEquals</a>, <a href="Namespace.html#toExternalForm(org.eclipse.ecf.core.identity.BaseID)">toExternalForm</a>, <a href="Namespace.html#toString()">toString</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">LongNamespace</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">LongNamespace</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="createInstance(java.lang.Object[])">createInstance</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createInstance</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;args)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Namespace.html#createInstance(java.lang.Object%5B%5D)">Namespace</a></code></span></div>
<div class="block">Make an instance of this namespace. Namespace subclasses, provided by plugins
must implement this method to construct ID instances for the given namespace.
<p>
</p>
See <a href="Namespace.html#getSupportedParameterTypes()"><code>Namespace.getSupportedParameterTypes()</code></a> to get information relevant to
deciding what parameter types are expected by this method.
<p>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Namespace.html#createInstance(java.lang.Object%5B%5D)">createInstance</a></code>&nbsp;in class&nbsp;<code><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - must not be <code>null></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ID created. Will not be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></code> - never thrown</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getScheme()">getScheme</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span>&nbsp;<span class="memberName">getScheme</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Namespace.html#getScheme()">Namespace</a></code></span></div>
<div class="block">Get the primary scheme associated with this namespace. Subclasses must
provide an implementation that returns a non-<code>null</code> scheme
identifier. Note that the returned scheme should <b>not</b> contain the
Namespace.SCHEME_SEPARATOR (\":\").</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Namespace.html#getScheme()">getScheme</a></code>&nbsp;in class&nbsp;<code><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String scheme identifier. Must not be <code>null</code>.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getSupportedParameterTypes()">getSupportedParameterTypes</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;[][]</span>&nbsp;<span class="memberName">getSupportedParameterTypes</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Namespace.html#getSupportedParameterTypes()">Namespace</a></code></span></div>
<div class="block">Get the supported parameter types for IDs created via subsequent calls to
<a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a>. Callers may use this method to determine
the available parameter types, and then create and pass in conforming Object
arrays to to <a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a>.
<p>
</p>
An empty two-dimensional array (new Class[0][0]) is the default returned by
this abstract superclass. This means that the Object [] passed to
<a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a> will be ignored.
<p>
</p>
Subsclasses should override this method to specify the parameters that they
will accept in calls to <a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a>. The rows of the
returned Class array are the acceptable types for a given invocation of
createInstance.
<p>
</p>
Consider the following example:
<p>
</p>
<pre>
public Class[][] getSupportedParameterTypes() {
return new Class[][] { { String.class }, { String.class, String.class } };
}
</pre>
The above means that there are two acceptable values for the Object [] passed
into <a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a>: 1) a single String, and 2) two
Strings. These would therefore be acceptable as input to createInstance:
<pre>
ID newID1 = namespace.createInstance(new Object[] { &quot;Hello&quot; });
ID newID2 = namespace.createInstance(new Object[] { &quot;Hello&quot;, &quot;There&quot;}};
</pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Namespace.html#getSupportedParameterTypes()">getSupportedParameterTypes</a></code>&nbsp;in class&nbsp;<code><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Class [][] an array of class []s. Rows of the returned
two-dimensional array define the acceptable parameter types for a
single call to <a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a>. If zero-length
Class arrays are returned (i.e. Class[0][0]), then Object []
parameters to <a href="Namespace.html#createInstance(java.lang.Object%5B%5D)"><code>Namespace.createInstance(Object[])</code></a> will be ignored.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LongID.LongNamespace.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>