blob: e6e930994eebd6d355e9ecb7cb0b6589851fb6f8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 -->
<title>IIDFactory (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, interface: IIDFactory">
<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":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,"i15":6,"i16":6,"i17":6,"i18":6,"i19":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";
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/IIDFactory.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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="Interface IIDFactory" class="title">Interface IIDFactory</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="IDFactory.html" title="class in org.eclipse.ecf.core.identity">IDFactory</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IIDFactory</span></pre>
<div class="block">Contract for <a href="IDFactory.html" title="class in org.eclipse.ecf.core.identity"><code>IDFactory</code></a></div>
<dl>
<dt><span class="simpleTagLabel">Restriction:</span></dt>
<dd>This interface is not intended to be implemented by clients.</dd>
</dl>
</section>
<section class="summary">
<ul class="blockList">
<!-- ========== 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="t3" class="tableTab" onclick="show(4);">Abstract 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="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addNamespace(org.eclipse.ecf.core.identity.Namespace)">addNamespace</a></span>&#8203;(<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</code></th>
<td class="colLast">
<div class="block">Add the given Namespace to our table of available Namespaces</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsNamespace(org.eclipse.ecf.core.identity.Namespace)">containsNamespace</a></span>&#8203;(<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</code></th>
<td class="colLast">
<div class="block">Check whether table contains given Namespace instance</div>
</td>
</tr>
<tr class="altColor" id="i2">
<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="#createGUID()">createGUID</a></span>()</code></th>
<td class="colLast">
<div class="block">Make a GUID using SHA-1 hash algorithm and a default of 16bits of data
length.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<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="#createGUID(int)">createGUID</a></span>&#8203;(int&nbsp;length)</code></th>
<td class="colLast">
<div class="block">Make a GUID using SHA-1 hash algorithm and a default of 16bits of data
length.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<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="#createID(java.lang.String,java.lang.Object%5B%5D)">createID</a></span>&#8203;(<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>&nbsp;namespaceName,
<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 a new identity.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<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="#createID(java.lang.String,java.lang.String)">createID</a></span>&#8203;(<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>&nbsp;namespaceName,
<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>&nbsp;idValue)</code></th>
<td class="colLast">
<div class="block">Make a new identity instance from a namespaceName and idValue.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<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="#createID(org.eclipse.ecf.core.identity.Namespace,java.lang.Object%5B%5D)">createID</a></span>&#8203;(<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n,
<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 a new identity.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<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="#createID(org.eclipse.ecf.core.identity.Namespace,java.lang.String)">createID</a></span>&#8203;(<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;namespace,
<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>&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Make a new identity instance from a namespace and String.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<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="#createLongID(long)">createLongID</a></span>&#8203;(long&nbsp;l)</code></th>
<td class="colLast">
<div class="block">Make a an ID from a long</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<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="#createStringID(java.lang.String)">createStringID</a></span>&#8203;(<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>&nbsp;idString)</code></th>
<td class="colLast">
<div class="block">Make a an ID from a String</div>
</td>
</tr>
<tr class="altColor" id="i10">
<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="#createURIID(java.lang.String)">createURIID</a></span>&#8203;(<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>&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Create a URIID from String.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<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="#createURIID(java.net.URI)">createURIID</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Create a URIID from URI.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<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="#createUuID()">createUuID</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a random UuID</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<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="#createUuID(java.lang.String)">createUuID</a></span>&#8203;(<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>&nbsp;uuid)</code></th>
<td class="colLast">
<div class="block">Create a UuID from String</div>
</td>
</tr>
<tr class="altColor" id="i14">
<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="#createUuID(java.net.URI)">createUuID</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;uuidURI)</code></th>
<td class="colLast">
<div class="block">Create a UuID from URI.</div>
</td>
</tr>
<tr class="rowColor" id="i15">
<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="#createUuID(java.util.UUID)">createUuID</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/UUID.html?is-external=true" title="class or interface in java.util" class="externalLink">UUID</a>&nbsp;uuid)</code></th>
<td class="colLast">
<div class="block">Create a UuID from UUID</div>
</td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNamespace(org.eclipse.ecf.core.identity.Namespace)">getNamespace</a></span>&#8203;(<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</code></th>
<td class="colLast">
<div class="block">Get the given Namespace instance from table</div>
</td>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><code><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNamespaceByName(java.lang.String)">getNamespaceByName</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get a Namespace instance by its string name.</div>
</td>
</tr>
<tr class="altColor" id="i18">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNamespaces()">getNamespaces</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a list of the current Namespace instances exposed by this factory.</div>
</td>
</tr>
<tr class="rowColor" id="i19">
<td class="colFirst"><code><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeNamespace(org.eclipse.ecf.core.identity.Namespace)">removeNamespace</a></span>&#8203;(<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</code></th>
<td class="colLast">
<div class="block">Remove the given Namespace from our table of available Namespaces</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ 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="addNamespace(org.eclipse.ecf.core.identity.Namespace)">addNamespace</a></h3>
<div class="memberSignature"><span class="returnType"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span>&nbsp;<span class="memberName">addNamespace</span>&#8203;(<span class="arguments"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
<div class="block">Add the given Namespace to our table of available Namespaces</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the Namespace to add</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Namespace the namespace already in table (null if Namespace not
previously in table)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - thrown if caller does not have appropriate
NamespacePermission for given namespace</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="containsNamespace(org.eclipse.ecf.core.identity.Namespace)">containsNamespace</a></h3>
<div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">containsNamespace</span>&#8203;(<span class="arguments"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
<div class="block">Check whether table contains given Namespace instance</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the Namespace to look for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if table does contain given Namespace, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - thrown if caller does not have appropriate
NamespacePermission for given namespace</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getNamespaces()">getNamespaces</a></h3>
<div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&gt;</span>&nbsp;<span class="memberName">getNamespaces</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
<div class="block">Get a list of the current Namespace instances exposed by this factory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List<Namespace> of Namespace instances</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - thrown if caller does not have appropriate
NamespacePermission for given namespace</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getNamespace(org.eclipse.ecf.core.identity.Namespace)">getNamespace</a></h3>
<div class="memberSignature"><span class="returnType"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span>&nbsp;<span class="memberName">getNamespace</span>&#8203;(<span class="arguments"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
<div class="block">Get the given Namespace instance from table</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the Namespace to look for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Namespace</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - thrown if caller does not have appropriate
NamespacePermission for given namespace</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getNamespaceByName(java.lang.String)">getNamespaceByName</a></h3>
<div class="memberSignature"><span class="returnType"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span>&nbsp;<span class="memberName">getNamespaceByName</span>&#8203;(<span class="arguments"><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>&nbsp;name)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
<div class="block">Get a Namespace instance by its string name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name to use for lookup</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Namespace instance. Null if not found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - thrown if caller does not have appropriate
NamespacePermission for given namespace</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createGUID()">createGUID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createGUID</span>()
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Make a GUID using SHA-1 hash algorithm and a default of 16bits of data
length. The value is Base64 encoded to allow for easy display.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new ID instance</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> - if ID cannot be constructed</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createGUID(int)">createGUID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createGUID</span>&#8203;(<span class="arguments">int&nbsp;length)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Make a GUID using SHA-1 hash algorithm and a default of 16bits of data
length. The value is Base64 encoded to allow for easy display.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>length</code> - the byte-length of data used to create a GUID</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new ID instance</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> - if ID cannot be constructed</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createID(org.eclipse.ecf.core.identity.Namespace,java.lang.Object[])">createID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createID</span>&#8203;(<span class="arguments"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n,
<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">Make a new identity. Given a Namespace, and an array of instance
constructor parameters, return a new instance of an ID belonging to the
given Namespace</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the Namespace to which the ID will belong</dd>
<dd><code>args</code> - an Object [] of the parameters for the ID instance constructor</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> - thrown if class for instantiator or instance can't be
loaded, if something goes wrong during instance
construction</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createID(java.lang.String,java.lang.Object[])">createID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createID</span>&#8203;(<span class="arguments"><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>&nbsp;namespaceName,
<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">Make a new identity. Given a Namespace name, and an array of instance
constructor parameters, return a new instance of an ID belonging to the
given Namespace</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>namespaceName</code> - the name of the Namespace to which the ID will belong</dd>
<dd><code>args</code> - an Object [] of the parameters for the ID instance constructor</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> - thrown if class for instantiator or ID instance can't be
loaded, if something goes wrong during instance
construction</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createID(org.eclipse.ecf.core.identity.Namespace,java.lang.String)">createID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createID</span>&#8203;(<span class="arguments"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;namespace,
<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>&nbsp;uri)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Make a new identity instance from a namespace and String.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>namespace</code> - the namespace to use to create the ID</dd>
<dd><code>uri</code> - the String uri to use to create the ID</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> - thrown if class for instantiator or ID instance can't be
loaded, if something goes wrong during instance
construction</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createID(java.lang.String,java.lang.String)">createID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createID</span>&#8203;(<span class="arguments"><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>&nbsp;namespaceName,
<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>&nbsp;idValue)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Make a new identity instance from a namespaceName and idValue. The
namespaceName is first used to lookup the namespace with
<a href="#getNamespaceByName(java.lang.String)"><code>getNamespaceByName(String)</code></a>, and then the result is passed into
<a href="#createID(org.eclipse.ecf.core.identity.Namespace,java.lang.String)"><code>createID(Namespace,String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>namespaceName</code> - the name of the namespace that should be used to create the ID</dd>
<dd><code>idValue</code> - the String value to use to create the ID</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> - thrown if class for instantiator or ID instance can't be
loaded, if something goes wrong during instance
construction</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createStringID(java.lang.String)">createStringID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createStringID</span>&#8203;(<span class="arguments"><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>&nbsp;idString)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Make a an ID from a String</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>idString</code> - the String to use as this ID's unique value. Note: It is
incumbent upon the caller of this method to be sure that the
given string allows the resulting ID to satisfy the ID
contract for global uniqueness within the associated
Namespace.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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> - thrown if class for instantiator or ID instance can't be
loaded, if something goes wrong during instance construction</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createLongID(long)">createLongID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createLongID</span>&#8203;(<span class="arguments">long&nbsp;l)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Make a an ID from a long</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>l</code> - the long to use as this ID's unique value. Note: It is
incumbent upon the caller of this method to be sure that the
given long allows the resulting ID to satisfy the ID contract
for global uniqueness within the associated Namespace.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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> - thrown if class for instantiator or ID instance can't be
loaded, if something goes wrong during instance construction</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createUuID(java.lang.String)">createUuID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createUuID</span>&#8203;(<span class="arguments"><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>&nbsp;uuid)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Create a UuID from String</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - the String to use. Must be in UUID format as returned from
UUID.toString(). Must not be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createUuID(java.util.UUID)">createUuID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createUuID</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/UUID.html?is-external=true" title="class or interface in java.util" class="externalLink">UUID</a>&nbsp;uuid)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Create a UuID from UUID</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - the UUID to use. Must not be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createUuID()">createUuID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createUuID</span>()
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Create a random UuID</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance from UUID.randomUUID()</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></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createUuID(java.net.URI)">createUuID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createUuID</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;uuidURI)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Create a UuID from URI.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuidURI</code> - the URI. Must not be null and must be in valid uuid syntax
form as specified by rfc4122 see
http://tools.ietf.org/html/rfc4122. Example:
'uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6'</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createURIID(java.net.URI)">createURIID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createURIID</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a>&nbsp;uri)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Create a URIID from URI.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the URI to use for the URIID. Must not be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="createURIID(java.lang.String)">createURIID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">createURIID</span>&#8203;(<span class="arguments"><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>&nbsp;uri)</span>
throws <span class="exceptions"><a href="IDCreateException.html" title="class in org.eclipse.ecf.core.identity">IDCreateException</a></span></div>
<div class="block">Create a URIID from String.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the String to use for the URIID. Must not be null, and must be
valid URI format as per URI.toString().</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid ID instance</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></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.5</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="removeNamespace(org.eclipse.ecf.core.identity.Namespace)">removeNamespace</a></h3>
<div class="memberSignature"><span class="returnType"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a></span>&nbsp;<span class="memberName">removeNamespace</span>&#8203;(<span class="arguments"><a href="Namespace.html" title="class in org.eclipse.ecf.core.identity">Namespace</a>&nbsp;n)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></span></div>
<div class="block">Remove the given Namespace from our table of available Namespaces</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the Namespace to remove</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Namespace the namespace already in table (null if Namespace not
previously in table)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink">SecurityException</a></code> - thrown if caller does not have appropriate
NamespacePermission for given namespace</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/IIDFactory.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>